@preventive/triage 1.0.0-alpha.44 → 1.0.0-alpha.46
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/client/linked-findings.js +3 -0
- package/common/bundle-metadata.d.ts +1 -0
- package/common/bundle-metadata.js +1 -1
- package/common/bundle-sources.js +25 -2
- package/common/default-scan-models.ts +1 -1
- package/common/dependency-reviews.d.ts +0 -5
- package/common/dependency-reviews.js +0 -17
- package/common/line-diff.js +5 -4
- package/common/managed/agent-tasks.ts +292 -0
- package/common/managed/github-agents.ts +92 -0
- package/common/managed/github-logins.ts +49 -0
- package/common/managed/roles.ts +7 -0
- package/common/managed/routes.js +88 -7
- package/common/managed/team-app.d.ts +5 -2
- package/common/managed/team-app.js +2 -2
- package/common/server-info.ts +3 -0
- package/common/workspace-app.js +6 -3
- package/out/brotli-fallback.js +3 -3
- package/out/chunk-2XUEZHIP.js +18 -18
- package/out/chunk-2ZDZWLFY.js +1 -0
- package/out/chunk-3PS4KWD2.js +10 -0
- package/out/chunk-4HI2MSAV.js +17 -0
- package/out/chunk-4UFAMJAX.js +1 -0
- package/out/chunk-7C7DWL7I.js +1 -0
- package/out/chunk-7XRR4OFU.js +1 -0
- package/out/chunk-BC2UCLFJ.js +1 -0
- package/out/chunk-BOIXMUU5.js +3 -0
- package/out/chunk-C4Z6ZBXV.js +6 -6
- package/out/chunk-CC4OM6TZ.js +3 -0
- package/out/chunk-G24A42V6.js +2 -0
- package/out/chunk-GDPCLSOS.js +2 -0
- package/out/chunk-GO7FT4OD.js +1 -0
- package/out/chunk-I2MDGSQX.js +3 -0
- package/out/chunk-IYPY47MC.js +1 -0
- package/out/chunk-IZ7POWI3.js +18 -0
- package/out/chunk-JCIIBLKR.js +1 -1
- package/out/chunk-JKGQ3O7O.js +6 -0
- package/out/chunk-LE5ZWLG4.js +235 -0
- package/out/chunk-MSION3G4.js +36 -0
- package/out/chunk-NRPC74AM.js +1 -1
- package/out/chunk-OKRLLE5I.js +17 -0
- package/out/chunk-OOJM4CTU.js +1 -1
- package/out/chunk-PNHBZGDD.js +1 -1
- package/out/chunk-PXK7EU4V.js +1 -0
- package/out/chunk-QB4CBOX2.js +1 -0
- package/out/chunk-R3NZFXVR.js +1 -0
- package/out/chunk-R5O6FAW4.js +1 -1
- package/out/chunk-S6GIXWQW.js +52 -0
- package/out/chunk-SXV2T5C4.js +80 -0
- package/out/chunk-TUII34K2.js +1 -1
- package/out/chunk-V3KWNNMY.js +1 -0
- package/out/chunk-VFWMQ3LG.js +2 -0
- package/out/chunk-VH4XMZIW.js +2 -0
- package/out/chunk-WFYLMF6Z.js +10 -0
- package/out/chunk-WQ74ZBZF.js +7 -0
- package/out/client-managed-import.js +3 -3
- package/out/client-managed.js +31 -35
- package/out/client-sync.js +11 -11
- package/out/compare.js +35 -0
- package/out/dialogs.js +51 -0
- package/out/github-issue-authorized.html +1 -1
- package/out/github-issue-authorized.js +1 -1
- package/out/graph.js +17 -17
- package/out/index.html +30 -34
- package/out/prism.js +14 -14
- package/out/scan.js +2 -0
- package/out/terminal.js +294 -293
- package/out/view.css +1 -1
- package/out/view.js +16 -107
- package/package.json +53 -6
- package/risk/actions/findings.js +161 -0
- package/risk/actions/resolve.js +219 -0
- package/risk/actions/scripts/commands.js +182 -0
- package/risk/actions/scripts/grade.js +113 -0
- package/risk/actions/scripts/packages.js +123 -0
- package/risk/actions/scripts/shell.js +169 -0
- package/risk/actions/uses.js +76 -0
- package/risk/actions/workflow.js +110 -0
- package/risk/files/hosts.js +6 -6
- package/risk/files/readability.js +23 -17
- package/risk/files/runs-code.js +18 -6
- package/risk/files/script.js +7 -3
- package/risk/files/stamps.js +8 -7
- package/risk/index.d.ts +71 -1
- package/risk/index.js +6 -2
- package/risk/npm/assess.js +1 -1
- package/risk/npm/compare.js +34 -10
- package/risk/npm/files.js +413 -2
- package/risk/npm/tarball.js +56 -73
- package/server-e2e/app.ts +5 -4
- package/server-e2e/http.ts +5 -2
- package/server-managed/agent-merges.ts +198 -0
- package/server-managed/app-agents.ts +30 -0
- package/server-managed/avatar-store.ts +1 -0
- package/server-managed/bundle-cache.ts +7 -1
- package/server-managed/combined.ts +3 -2
- package/server-managed/commit-coauthors.ts +83 -0
- package/server-managed/commit-lockfiles.ts +72 -0
- package/server-managed/config.ts +6 -0
- package/server-managed/db-methods.ts +66 -19
- package/server-managed/db-neon.ts +89 -21
- package/server-managed/db-schema.ts +13 -2
- package/server-managed/db.ts +9 -1
- package/server-managed/dependabot-access.ts +60 -0
- package/server-managed/dependabot-alerts.ts +185 -0
- package/server-managed/dependency-review-comments.ts +97 -0
- package/server-managed/dependency-reviews.ts +78 -18
- package/server-managed/github-accounts.ts +33 -0
- package/server-managed/github-actions.ts +71 -0
- package/server-managed/github-app.ts +33 -13
- package/server-managed/github-errors.ts +2 -0
- package/server-managed/github-issue-links.ts +11 -5
- package/server-managed/github-link-oauth.ts +69 -0
- package/server-managed/github-links.ts +204 -0
- package/server-managed/github-oauth.ts +5 -2
- package/server-managed/github-pulls.ts +2 -2
- package/server-managed/github-requests.ts +39 -0
- package/server-managed/github-users.ts +30 -0
- package/server-managed/http-response.ts +10 -2
- package/server-managed/http.ts +1251 -97
- package/server-managed/index.ts +13 -8
- package/server-managed/kept-briefly.ts +37 -0
- package/server-managed/locked-packages.ts +37 -16
- package/server-managed/lockfile-scope.ts +49 -0
- package/server-managed/npm-delta-worker.js +23 -0
- package/server-managed/npm-delta.ts +178 -0
- package/server-managed/npm-insights.ts +20 -11
- package/server-managed/npm-kept.ts +83 -6
- package/server-managed/npm-loads.ts +114 -37
- package/server-managed/npm-packages.ts +110 -64
- package/server-managed/npm-risk.ts +4 -1
- package/server-managed/pretty-print.ts +67 -23
- package/server-managed/pull-comment-reviews.ts +161 -0
- package/server-managed/pull-dependencies.ts +300 -0
- package/server-managed/pull-dependency-reviews.ts +318 -0
- package/server-managed/pull-reviews.ts +205 -0
- package/server-managed/queue.ts +16 -0
- package/server-managed/release-commits.ts +84 -0
- package/server-managed/rename-diff.ts +22 -13
- package/server-managed/report-sources.ts +1 -1
- package/server-managed/report-store.ts +42 -9
- package/server-managed/repository-actions.ts +218 -0
- package/server-managed/repository-agents.ts +220 -0
- package/server-managed/repository-browser.ts +166 -37
- package/server-managed/repository-changes.ts +284 -0
- package/server-managed/repository-code.ts +52 -0
- package/server-managed/repository-dependency-reviews.ts +157 -0
- package/server-managed/repository-history.ts +461 -0
- package/server-managed/repository-issues.ts +181 -0
- package/server-managed/repository-pulse.ts +439 -0
- package/server-managed/repository-risk-audit.ts +13 -0
- package/server-managed/repository-risk-read.ts +170 -0
- package/server-managed/repository-risk.ts +133 -118
- package/server-managed/reviewed-dependencies.ts +149 -0
- package/server-managed/session.ts +27 -9
- package/server-managed/sql.ts +6 -3
- package/server-managed/storage-stores.ts +5 -0
- package/server-managed/storage.ts +4 -2
- package/server-managed/team-app.ts +19 -3
- package/server-managed/team-reports.ts +24 -12
- package/server-managed/upstream-cache.ts +12 -0
- package/server-managed/workspace-shares.ts +4 -1
- package/server.ts +25 -5
- package/out/chunk-2ABLKCOY.js +0 -46
- package/out/chunk-2KBF5TZ7.js +0 -2
- package/out/chunk-35VE6CDH.js +0 -2
- package/out/chunk-3BZ7JERB.js +0 -1
- package/out/chunk-4XCDFGDP.js +0 -10
- package/out/chunk-5LSXOLUS.js +0 -1
- package/out/chunk-5RCM2J63.js +0 -1
- package/out/chunk-7B6HB4D7.js +0 -1
- package/out/chunk-AJ4GTATZ.js +0 -3
- package/out/chunk-CH4UN6WK.js +0 -225
- package/out/chunk-CMQA4DM6.js +0 -1
- package/out/chunk-CVVJAXVY.js +0 -2
- package/out/chunk-DIJJNTRH.js +0 -10
- package/out/chunk-EDKLBQQN.js +0 -17
- package/out/chunk-F47DXCEV.js +0 -33
- package/out/chunk-FK3DZEKL.js +0 -1
- package/out/chunk-G6AJWENO.js +0 -1
- package/out/chunk-GJ4IUCNS.js +0 -1
- package/out/chunk-GNXOKIGP.js +0 -80
- package/out/chunk-GZ4MS3TE.js +0 -13
- package/out/chunk-GZWM7UQM.js +0 -2
- package/out/chunk-IU3CCINR.js +0 -3
- package/out/chunk-K3X5EJBQ.js +0 -2
- package/out/chunk-KEX2ATEW.js +0 -2
- package/out/chunk-KYCNJVB7.js +0 -1
- package/out/chunk-LPCTJYNA.js +0 -7
- package/out/chunk-O4RJY5TP.js +0 -2
- package/out/chunk-OD4LPN3H.js +0 -1
- package/out/chunk-QWDWTBM7.js +0 -1
- package/out/chunk-QYWKC557.js +0 -1
- package/out/chunk-R75XOKUP.js +0 -1
- package/out/chunk-SWTLADW5.js +0 -1
- package/out/chunk-T7OKH4VW.js +0 -1
- package/out/chunk-TZ5KB2Y5.js +0 -10
- package/out/chunk-UNTRGE26.js +0 -2
- package/out/chunk-UTR2LVME.js +0 -2
- package/out/chunk-UYAXVRVL.js +0 -1
- package/out/chunk-V3ME6FI5.js +0 -2
- package/out/chunk-V5O7M2YT.js +0 -1
- package/out/chunk-VIHGO77Y.js +0 -1
- package/out/chunk-W4J3MGLB.js +0 -1
- package/out/chunk-WGG7KQUH.js +0 -1
- package/out/chunk-XYFXXB2G.js +0 -10
- package/out/chunk-ZESLQCTF.js +0 -6
|
@@ -1,12 +1,29 @@
|
|
|
1
|
+
import { createHash } from 'node:crypto'
|
|
1
2
|
import type { ManagedConfig } from './config.ts'
|
|
2
3
|
import type { SelectedRepo } from './db.ts'
|
|
3
|
-
import { GithubApiError, githubJson,
|
|
4
|
+
import { GithubApiError, type GithubIdentity, READ_PERMISSIONS, githubJson, githubRepoPermission, githubUserIdentity, onTokenRejected, repoAccessToken } from './github-app.ts'
|
|
4
5
|
import { MAX_PACKAGE_BYTES, readPackageEntryPoints } from './package-entry-points.ts'
|
|
5
6
|
import { readSolidityEntryPoints } from './solidity-entry-points.ts'
|
|
6
7
|
import { parseGithubCommit } from './bundle-commits.ts'
|
|
8
|
+
import { appDependabotAlerts } from './dependabot-access.ts'
|
|
7
9
|
|
|
8
10
|
const REFS_PAGE = 100
|
|
9
11
|
|
|
12
|
+
// Each branch or tag GitHub lists, by its name and commit, those it names
|
|
13
|
+
// one for.
|
|
14
|
+
const refCommits = (items: { name?: unknown; commit?: { sha?: unknown } }[]) => items.flatMap(item => typeof item?.name === 'string' && item.name
|
|
15
|
+
&& typeof item.commit?.sha === 'string' && /^[a-f\d]{40}$/u.test(item.commit.sha) ? [{ name: item.name, sha: item.commit.sha }] : [])
|
|
16
|
+
|
|
17
|
+
// Each branch GitHub lists, by its name and commit. Branches are listed by
|
|
18
|
+
// name, a full page of them leaving the default branch out where many come
|
|
19
|
+
// before it: its commit is read apart then, by its ref, none where that fails.
|
|
20
|
+
async function branchCommits(read: (suffix: string) => Promise<unknown>, branches: { name?: unknown; commit?: { sha?: unknown } }[], defaultBranch: string) {
|
|
21
|
+
const listed = refCommits(branches)
|
|
22
|
+
if (!defaultBranch || branches.length < REFS_PAGE || listed.some(item => item.name === defaultBranch)) return listed
|
|
23
|
+
const ref = await read(`/git/ref/heads/${defaultBranch.split('/').map(encodeURIComponent).join('/')}`).catch(() => null) as { object?: { sha?: unknown } } | null
|
|
24
|
+
return typeof ref?.object?.sha === 'string' && /^[a-f\d]{40}$/u.test(ref.object.sha) ? [...listed, { name: defaultBranch, sha: ref.object.sha }] : listed
|
|
25
|
+
}
|
|
26
|
+
|
|
10
27
|
export interface RepositoryEntry { name: string; path: string; type: 'dir' | 'file' | 'symlink' | 'submodule' }
|
|
11
28
|
|
|
12
29
|
// Restricted managers can walk the ancestors of their grants, without seeing
|
|
@@ -19,20 +36,68 @@ export function scopedDirectory(path: string, scopes: (string | null)[]): Reposi
|
|
|
19
36
|
}
|
|
20
37
|
|
|
21
38
|
export interface RepositoryBrowserUser { githubUserId: number | null; token: string | null }
|
|
22
|
-
type GithubIdentity = Awaited<ReturnType<typeof githubUserIdentity>>
|
|
23
39
|
|
|
24
40
|
function credentialFailure(err: unknown): err is GithubApiError {
|
|
25
41
|
return err instanceof GithubApiError && ([401, 404].includes(err.status) || err.message === 'github-status-403')
|
|
26
42
|
}
|
|
27
43
|
|
|
28
|
-
//
|
|
29
|
-
//
|
|
44
|
+
// GitHub's answer on a user's access to a repository, as checkAccess reads it:
|
|
45
|
+
// the repository's metadata, which credential reads it (the user's token, the
|
|
46
|
+
// App installation's, or none, as for a public repository read anonymously)
|
|
47
|
+
// and the permission level GitHub told, where it was asked. Kept per user, by
|
|
48
|
+
// their GitHub id and token, and per repository, by its id, name and
|
|
49
|
+
// installation, for config.repositoryAccessCacheMs; only access granted is kept.
|
|
50
|
+
// One answered for a user with a token is kept no longer once GitHub rejects
|
|
51
|
+
// that token (`userToken`, hashed), whichever credential reads it: a private
|
|
52
|
+
// repository's was granted on who that token told GitHub they are. The next
|
|
53
|
+
// check asks GitHub, falling back to the installation's or none as it does.
|
|
54
|
+
type RepoMetadata = { id?: unknown; full_name?: unknown; private?: unknown; visibility?: unknown; default_branch?: unknown }
|
|
55
|
+
type AccessVerdict = { until: number; data: RepoMetadata; credential: 'user' | 'app' | 'none'; level: string | null; userToken: string | null }
|
|
56
|
+
type VerdictCache = { get(): AccessVerdict | undefined; set(verdict: Omit<AccessVerdict, 'until' | 'userToken'>): void }
|
|
57
|
+
const MAX_ACCESS_VERDICTS = 1000
|
|
58
|
+
// By the fetch reading GitHub, as installation tokens are: a test's own.
|
|
59
|
+
const accessVerdicts = new WeakMap<typeof fetch, Map<string, AccessVerdict>>()
|
|
60
|
+
const hashed = (token: string) => createHash('sha256').update(token).digest('hex')
|
|
61
|
+
onTokenRejected((token, fetchImpl) => {
|
|
62
|
+
const kept = accessVerdicts.get(fetchImpl)
|
|
63
|
+
if (!kept) return
|
|
64
|
+
const rejected = hashed(token)
|
|
65
|
+
for (const [key, verdict] of kept) if (verdict.userToken === rejected) kept.delete(key)
|
|
66
|
+
})
|
|
67
|
+
|
|
68
|
+
function verdictCache(config: ManagedConfig, user: RepositoryBrowserUser, repo: SelectedRepo, fetchImpl: typeof fetch): VerdictCache | null {
|
|
69
|
+
const keepMs = config.repositoryAccessCacheMs
|
|
70
|
+
if (!(keepMs > 0)) return null
|
|
71
|
+
let verdicts = accessVerdicts.get(fetchImpl)
|
|
72
|
+
if (!verdicts) { verdicts = new Map(); accessVerdicts.set(fetchImpl, verdicts) }
|
|
73
|
+
const kept = verdicts
|
|
74
|
+
// The token hashed with the rest, never kept as it is.
|
|
75
|
+
const key = createHash('sha256').update(JSON.stringify([user.githubUserId, user.token, repo.repoId, repo.fullName.toLowerCase(), repo.installationId, config.githubAppId])).digest('hex')
|
|
76
|
+
return {
|
|
77
|
+
get() {
|
|
78
|
+
const verdict = kept.get(key)
|
|
79
|
+
if (verdict && verdict.until > Date.now()) return verdict
|
|
80
|
+
kept.delete(key)
|
|
81
|
+
return undefined
|
|
82
|
+
},
|
|
83
|
+
set(verdict) {
|
|
84
|
+
kept.delete(key)
|
|
85
|
+
kept.set(key, { ...verdict, until: Date.now() + keepMs, userToken: user.token ? hashed(user.token) : null })
|
|
86
|
+
while (kept.size > MAX_ACCESS_VERDICTS) kept.delete(kept.keys().next().value!)
|
|
87
|
+
},
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
// Create once per HTTP request. Coalesce concurrent credential lookups, and
|
|
92
|
+
// keep GitHub's answer on each user's access to each repository a while
|
|
93
|
+
// (verdictCache), never sharing credentials or answers across users.
|
|
30
94
|
export function createRepositoryBrowser(config: ManagedConfig, user: RepositoryBrowserUser, fetchImpl: typeof fetch = globalThis.fetch) {
|
|
31
95
|
const tokens = new Map<number, Promise<string | null>>()
|
|
32
96
|
let identity: Promise<GithubIdentity> | undefined
|
|
33
|
-
|
|
97
|
+
// The user as GitHub tells them, asked once a request.
|
|
98
|
+
const getIdentity = (): Promise<GithubIdentity> => {
|
|
34
99
|
if (!user.token || user.githubUserId == null) return Promise.reject(new GithubApiError(404, 'no-repository'))
|
|
35
|
-
if (!identity
|
|
100
|
+
if (!identity) {
|
|
36
101
|
identity = githubUserIdentity(user.token, fetchImpl).then(value => {
|
|
37
102
|
if (value.id !== user.githubUserId) throw new GithubApiError(404, 'no-repository')
|
|
38
103
|
return value
|
|
@@ -53,56 +118,120 @@ export function createRepositoryBrowser(config: ManagedConfig, user: RepositoryB
|
|
|
53
118
|
if (!cached) tokens.set(repo.installationId, token)
|
|
54
119
|
return token
|
|
55
120
|
}
|
|
56
|
-
|
|
121
|
+
// Its Dependabot alerts, with the token of the installation GitHub tells
|
|
122
|
+
// covers it, where the user's own access lets them see them
|
|
123
|
+
// (dependabot-access.ts).
|
|
124
|
+
return repositoryReader(repo, user.token, installationToken, getIdentity, fetchImpl, verdictCache(config, user, repo, fetchImpl)).then(reader => ({ ...reader,
|
|
125
|
+
dependabotAlerts: () => appDependabotAlerts(config, repo, { identity: getIdentity, permission: reader.permission }, fetchImpl) }))
|
|
57
126
|
},
|
|
58
127
|
}
|
|
59
128
|
}
|
|
60
129
|
|
|
61
|
-
|
|
130
|
+
// The files of the tree `tree` (its id) of the repository `fullName`, and of
|
|
131
|
+
// every tree under it, as GitHub lists them at once with `token`, a reader's
|
|
132
|
+
// (readToken): how many and their bytes, or null where GitHub cuts the
|
|
133
|
+
// listing short, as it does past 100,000 entries.
|
|
134
|
+
export async function repositoryTreeFiles(fullName: string, token: string | null, tree: string, fetchImpl: typeof fetch = globalThis.fetch) {
|
|
135
|
+
if (!/^[a-f\d]{40}$/u.test(tree)) throw new GithubApiError(400, 'bad-tree')
|
|
136
|
+
const url = `https://api.github.com/repos/${fullName.split('/').map(encodeURIComponent).join('/')}/git/trees/${tree}?recursive=1`
|
|
137
|
+
const data = await githubJson(url, token, fetchImpl) as { tree?: unknown; truncated?: unknown }
|
|
138
|
+
if (!Array.isArray(data?.tree)) throw new GithubApiError(502, 'github-malformed')
|
|
139
|
+
if (data.truncated === true) return null
|
|
140
|
+
let bytes = 0, files = 0
|
|
141
|
+
for (const item of data.tree as { type?: unknown; size?: unknown }[]) {
|
|
142
|
+
if (item?.type !== 'blob') continue
|
|
143
|
+
files++
|
|
144
|
+
if (typeof item.size === 'number' && item.size > 0) bytes += item.size
|
|
145
|
+
}
|
|
146
|
+
return { files, bytes }
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
type Access = { data: RepoMetadata; token: string | null; level: string | null }
|
|
150
|
+
|
|
151
|
+
// GitHub asked whether the user may read `repo`: its metadata, read with
|
|
152
|
+
// `token` (the reader's credential so far), else the installation's, else
|
|
153
|
+
// none; and of one not public, the user's permission, read with the
|
|
154
|
+
// installation's. What it told, the token reading it, and the level asked.
|
|
155
|
+
async function askAccess(repo: SelectedRepo, start: string | null, userToken: string | null, installationToken: () => Promise<string | null>,
|
|
156
|
+
getIdentity: () => Promise<GithubIdentity>, fetchImpl: typeof fetch): Promise<Access> {
|
|
62
157
|
const base = `https://api.github.com/repos/${repo.fullName.split('/').map(encodeURIComponent).join('/')}`
|
|
63
|
-
|
|
64
|
-
// Nonpublic reads still require the repository App and the effective-user gate.
|
|
65
|
-
let token = userToken ?? await installationToken()
|
|
66
|
-
const read = (suffix: string) => githubJson(base + suffix, token, fetchImpl)
|
|
158
|
+
let token = start
|
|
67
159
|
const metadata = async () => {
|
|
68
|
-
try { return await
|
|
160
|
+
try { return await githubJson(base, token, fetchImpl) }
|
|
69
161
|
catch (err) {
|
|
70
162
|
if (!token || !credentialFailure(err)) throw err
|
|
71
163
|
const fallback = await installationToken()
|
|
72
164
|
if (fallback && fallback !== token) {
|
|
73
165
|
token = fallback
|
|
74
|
-
try { return await
|
|
166
|
+
try { return await githubJson(base, token, fetchImpl) } catch (fallbackError) { if (!credentialFailure(fallbackError)) throw fallbackError }
|
|
75
167
|
}
|
|
76
168
|
// Anonymous fallback is only for unavailable credentials, never rate
|
|
77
169
|
// limits, network errors, or GitHub outages.
|
|
78
170
|
token = null
|
|
79
|
-
return
|
|
171
|
+
return githubJson(base, token, fetchImpl)
|
|
80
172
|
}
|
|
81
173
|
}
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
174
|
+
// A repository last known private asks who the user is as it asks for its
|
|
175
|
+
// metadata, not after: its permission is asked of them.
|
|
176
|
+
if (repo.private && userToken) getIdentity().catch(() => {})
|
|
177
|
+
// Stored visibility can be stale (or internal with private=false). Require
|
|
178
|
+
// current, explicit public visibility or the caller's effective permission.
|
|
179
|
+
const data = await metadata() as RepoMetadata
|
|
180
|
+
if (data?.id !== repo.repoId || typeof data.full_name !== 'string' || data.full_name.toLowerCase() !== repo.fullName.toLowerCase()) {
|
|
181
|
+
throw new GithubApiError(404, 'no-repository')
|
|
182
|
+
}
|
|
183
|
+
if (data.private === false && data.visibility === 'public') return { data, token, level: null }
|
|
184
|
+
if (!token) throw new GithubApiError(404, 'no-repository')
|
|
185
|
+
const appToken = await installationToken()
|
|
186
|
+
if (!appToken) throw new GithubApiError(404, 'no-repository')
|
|
187
|
+
const level = await githubRepoPermission(repo.fullName, appToken, await getIdentity(), fetchImpl)
|
|
188
|
+
if (!READ_PERMISSIONS.has(level)) throw new GithubApiError(404, 'no-repository')
|
|
189
|
+
return { data, token: appToken, level }
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
// GitHub's answer as kept (verdictCache), with the credential it chose,
|
|
193
|
+
// where that credential is still had; else asked (`ask`), and kept where it
|
|
194
|
+
// grants access.
|
|
195
|
+
async function keptAccess(verdicts: VerdictCache | null, userToken: string | null, installationToken: () => Promise<string | null>,
|
|
196
|
+
ask: () => Promise<Access>): Promise<Access> {
|
|
197
|
+
const kept = verdicts?.get()
|
|
198
|
+
if (kept) {
|
|
199
|
+
const credential = kept.credential === 'user' ? userToken : kept.credential === 'app' ? await installationToken() : null
|
|
200
|
+
if (kept.credential === 'none' || credential) return { data: kept.data, token: credential, level: kept.level }
|
|
201
|
+
}
|
|
202
|
+
const asked = await ask()
|
|
203
|
+
const { id, full_name, private: hidden, visibility, default_branch } = asked.data
|
|
204
|
+
const data = { id, full_name, private: hidden, visibility, default_branch }
|
|
205
|
+
verdicts?.set({ data, credential: asked.token === null ? 'none' : asked.token === userToken ? 'user' : 'app', level: asked.level })
|
|
206
|
+
return { ...asked, data }
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
async function repositoryReader(repo: SelectedRepo, userToken: string | null, installationToken: () => Promise<string | null>, getIdentity: (fresh?: boolean) => Promise<GithubIdentity>, fetchImpl: typeof fetch,
|
|
210
|
+
verdicts: VerdictCache | null) {
|
|
211
|
+
const base = `https://api.github.com/repos/${repo.fullName.split('/').map(encodeURIComponent).join('/')}`
|
|
212
|
+
// Public reads can use the signed-in user's quota without repository grants.
|
|
213
|
+
// Nonpublic reads still require the repository App and the effective-user gate,
|
|
214
|
+
// whose permission level is kept (`level`).
|
|
215
|
+
let level: string | null = null, token = userToken ?? await installationToken()
|
|
216
|
+
const read = (suffix: string) => githubJson(base + suffix, token, fetchImpl)
|
|
217
|
+
const checkAccess = async (): Promise<RepoMetadata> => {
|
|
218
|
+
const access = await keptAccess(verdicts, userToken, installationToken, () => askAccess(repo, token, userToken, installationToken, getIdentity, fetchImpl))
|
|
219
|
+
token = access.token
|
|
220
|
+
level = access.level
|
|
221
|
+
return access.data
|
|
98
222
|
}
|
|
99
223
|
const current = await checkAccess()
|
|
100
224
|
const defaultBranch = typeof current.default_branch === 'string' ? current.default_branch : ''
|
|
101
225
|
return {
|
|
102
|
-
|
|
226
|
+
// Its visibility and the user's permission asked again, the user as
|
|
227
|
+
// GitHub told them earlier in the request, not asked again.
|
|
228
|
+
recheckAccess: () => checkAccess(),
|
|
103
229
|
// Server-only credential, selected by the same live visibility/permission
|
|
104
230
|
// gate as directory browsing. Never included in an HTTP response.
|
|
105
231
|
readToken: () => token,
|
|
232
|
+
// The user's permission level on it where the gate asked GitHub of it, as
|
|
233
|
+
// for a private repository; null for a public one.
|
|
234
|
+
permission: () => level,
|
|
106
235
|
async refs() {
|
|
107
236
|
// Suggestions are bounded; the input also accepts any branch or tag name.
|
|
108
237
|
const list = async (kind: string) => {
|
|
@@ -112,11 +241,11 @@ async function repositoryReader(repo: SelectedRepo, userToken: string | null, in
|
|
|
112
241
|
}
|
|
113
242
|
const [branches, tags] = await Promise.all([list('branches'), list('tags')])
|
|
114
243
|
const names = (items: { name?: unknown }[]) => items.flatMap(item => typeof item?.name === 'string' ? [item.name] : [])
|
|
115
|
-
// Each tag's commit, for the
|
|
116
|
-
//
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
244
|
+
// Each branch's and tag's commit, for the code viewer's header to name a
|
|
245
|
+
// commit by, and each tag's for the tag cache. A full page may leave
|
|
246
|
+
// tags out; only a shorter one lists every tag.
|
|
247
|
+
return { defaultBranch, branches: names(branches), tags: names(tags), branchCommits: await branchCommits(read, branches, defaultBranch),
|
|
248
|
+
tagCommits: refCommits(tags), tagsComplete: tags.length < REFS_PAGE }
|
|
120
249
|
},
|
|
121
250
|
async commit(ref: string) {
|
|
122
251
|
if (/^[a-f\d]{40}$/iu.test(ref)) return ref
|
|
@@ -0,0 +1,284 @@
|
|
|
1
|
+
// The files each commit changes, as the code viewer's Replay plays them
|
|
2
|
+
// (GET /api/admin/repositories/changes), as `git log --name-status` lists
|
|
3
|
+
// them: each file's path and whether the commit added (`A`), modified (`M`),
|
|
4
|
+
// removed (`D`) or renamed (`R`, with the path it had) it, as GitHub's REST
|
|
5
|
+
// API lists a commit's files (GET /repos/:owner/:repo/commits/:sha), a
|
|
6
|
+
// page of FILES_PAGE at a time, as many as MAX_FILES, `more` where it had
|
|
7
|
+
// more. What a commit changes never changes, so each is kept by the commit
|
|
8
|
+
// (`kept`), whole, read of GitHub once; what a reader is answered, only the
|
|
9
|
+
// files within the directory they asked of (changesWithin). And the files a
|
|
10
|
+
// commit holds, which Replay starts from (GET /api/admin/repositories/tree),
|
|
11
|
+
// as GitHub lists its tree at once (repositoryTree), kept as well.
|
|
12
|
+
|
|
13
|
+
import { GithubApiError, githubJson } from './github-app.ts'
|
|
14
|
+
|
|
15
|
+
// Commits an answer tells at most, read of GitHub as many at once as
|
|
16
|
+
// CHANGES_PARALLEL.
|
|
17
|
+
export const CHANGES_ASKED = 50
|
|
18
|
+
const CHANGES_PARALLEL = 6
|
|
19
|
+
// A commit's files read, as many as fill MAX_FILES, FILES_PAGE a page (the
|
|
20
|
+
// most GitHub lists a page; it lists fewer, unasked).
|
|
21
|
+
export const MAX_FILES = 300
|
|
22
|
+
export const FILES_PAGE = 100
|
|
23
|
+
const MAX_PATH = 4096
|
|
24
|
+
const SHA = /^[a-f\d]{40}$/u
|
|
25
|
+
|
|
26
|
+
export type ChangeStatus = 'A' | 'M' | 'D' | 'R'
|
|
27
|
+
// A file a commit changes: its path, its status, and a rename's path before.
|
|
28
|
+
export type ChangedFile = [path: string, status: Exclude<ChangeStatus, 'R'>] | [path: string, status: 'R', from: string]
|
|
29
|
+
export interface CommitChanges { files: ChangedFile[]; more: boolean }
|
|
30
|
+
|
|
31
|
+
// What each commit changes kept, by the commit.
|
|
32
|
+
export interface ChangesStore {
|
|
33
|
+
read(shas: string[]): Promise<Map<string, CommitChanges>>
|
|
34
|
+
write(sha: string, changes: CommitChanges): Promise<void>
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
const pathOf = (value: unknown) => typeof value === 'string' && value !== '' && value.length <= MAX_PATH && !/\p{Cc}/u.test(value) ? value : null
|
|
38
|
+
|
|
39
|
+
// A file's status as git names it: a copy is a file added; one GitHub
|
|
40
|
+
// lists unchanged (its mode alone changed, say) changes none.
|
|
41
|
+
const STATUSES: Record<string, ChangeStatus> = { added: 'A', copied: 'A', modified: 'M', changed: 'M', removed: 'D', renamed: 'R' }
|
|
42
|
+
|
|
43
|
+
type GithubFile = { filename?: unknown; status?: unknown; previous_filename?: unknown }
|
|
44
|
+
|
|
45
|
+
// A commit's files as GitHub lists them; a rename it names no path before
|
|
46
|
+
// for, a file added.
|
|
47
|
+
export function commitChanges(data: unknown): CommitChanges {
|
|
48
|
+
const listed = (data as { files?: unknown } | null)?.files
|
|
49
|
+
if (!Array.isArray(listed)) throw new GithubApiError(502, 'github-malformed')
|
|
50
|
+
const files = (listed as GithubFile[]).slice(0, MAX_FILES).flatMap((file): ChangedFile[] => {
|
|
51
|
+
const path = pathOf(file?.filename)
|
|
52
|
+
const status = typeof file?.status === 'string' ? STATUSES[file.status] : undefined
|
|
53
|
+
if (!path || !status) return []
|
|
54
|
+
const from = status === 'R' ? pathOf(file.previous_filename) : null
|
|
55
|
+
return [status === 'R' ? from ? [path, 'R', from] : [path, 'A'] : [path, status]]
|
|
56
|
+
})
|
|
57
|
+
return { files, more: listed.length >= MAX_FILES }
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
// What a commit changes within the directory `path` ('' the whole
|
|
61
|
+
// repository): its files there, a rename across its edge the file added
|
|
62
|
+
// where it came in, removed where it went out.
|
|
63
|
+
export function changesWithin({ files, more }: CommitChanges, path: string): CommitChanges {
|
|
64
|
+
if (path === '') return { files, more }
|
|
65
|
+
const within = (file: string) => file.startsWith(`${path}/`)
|
|
66
|
+
return { more, files: files.flatMap((file): ChangedFile[] => {
|
|
67
|
+
if (file[1] !== 'R') return within(file[0]) ? [file] : []
|
|
68
|
+
const [to, , from] = file
|
|
69
|
+
if (within(to)) return [within(from) ? file : [to, 'A']]
|
|
70
|
+
return within(from) ? [[from, 'D']] : []
|
|
71
|
+
}) }
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
// Runs `run` for each of `items`, as many at once as `parallel`.
|
|
75
|
+
async function eachOf<T>(items: T[], parallel: number, run: (item: T) => Promise<void>) {
|
|
76
|
+
let next = 0
|
|
77
|
+
await Promise.all(Array.from({ length: Math.min(parallel, items.length) }, async () => { while (next < items.length) await run(items[next++]!) }))
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
// A commit's files as GitHub lists them, read a page at a time while each
|
|
81
|
+
// is full, till MAX_FILES are.
|
|
82
|
+
async function commitFiles(url: string, token: string | null, fetchImpl: typeof fetch) {
|
|
83
|
+
const files: unknown[] = []
|
|
84
|
+
for (let page = 1; files.length < MAX_FILES; page++) {
|
|
85
|
+
const data = await githubJson(`${url}?per_page=${FILES_PAGE}&page=${page}`, token, fetchImpl) as { files?: unknown } | null
|
|
86
|
+
if (!Array.isArray(data?.files)) throw new GithubApiError(502, 'github-malformed')
|
|
87
|
+
files.push(...data.files)
|
|
88
|
+
if (data.files.length < FILES_PAGE) break
|
|
89
|
+
}
|
|
90
|
+
return { files }
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
// What each of `shas` changes, kept, else read of GitHub and then kept; null
|
|
94
|
+
// for one GitHub has no commit of (as one of another repository is).
|
|
95
|
+
export async function repositoryChanges(fullName: string, token: string | null, shas: string[], kept: ChangesStore,
|
|
96
|
+
fetchImpl: typeof fetch = globalThis.fetch): Promise<Map<string, CommitChanges | null>> {
|
|
97
|
+
const asked = [...new Set(shas)].filter(sha => SHA.test(sha))
|
|
98
|
+
const found = new Map<string, CommitChanges | null>(await kept.read(asked))
|
|
99
|
+
const repo = `https://api.github.com/repos/${fullName.split('/').map(encodeURIComponent).join('/')}`
|
|
100
|
+
await eachOf(asked.filter(sha => !found.has(sha)), CHANGES_PARALLEL, async sha => {
|
|
101
|
+
try {
|
|
102
|
+
const changes = commitChanges(await commitFiles(`${repo}/commits/${sha}`, token, fetchImpl))
|
|
103
|
+
found.set(sha, changes)
|
|
104
|
+
await kept.write(sha, changes)
|
|
105
|
+
} catch (err) {
|
|
106
|
+
// No such commit: GitHub's 404, or its 422 for an id naming none.
|
|
107
|
+
if (err instanceof GithubApiError && (err.message === 'github-not-found' || err.message === 'github-status-422')) found.set(sha, null)
|
|
108
|
+
else throw err
|
|
109
|
+
}
|
|
110
|
+
})
|
|
111
|
+
return new Map(asked.map(sha => [sha, found.get(sha) ?? null]))
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
// The files a commit (or a tree) holds, as many as MAX_TREE_FILES, each by its path and
|
|
115
|
+
// its bytes (`sizes`, in the same order), as
|
|
116
|
+
// GitHub lists its tree and every tree under it at once
|
|
117
|
+
// (GET /repos/:owner/:repo/git/trees/:tree?recursive=1); where GitHub cuts
|
|
118
|
+
// that listing short (past 100,000 entries or 7 MB, as a large repository's
|
|
119
|
+
// is), as GitHub advises: the tree's own entries listed alone, and each tree
|
|
120
|
+
// in it read so in turn, as many at once as TREES_PARALLEL (treeByTrees).
|
|
121
|
+
// Its blobs, not its directories nor submodules, sorted by path; past
|
|
122
|
+
// MAX_TREE_FILES those nearest its root of those read, `cut` where some are
|
|
123
|
+
// left out: more files than MAX_TREE_FILES, a tree's own entries cut short,
|
|
124
|
+
// or more trees to read than MAX_TREE_READS.
|
|
125
|
+
// Null for a commit GitHub has none of. Kept by the commit and the rules it
|
|
126
|
+
// is read by (TREES_READ), a tree kept by older ones (without sizes, the
|
|
127
|
+
// last) read again.
|
|
128
|
+
export const MAX_TREE_FILES = 75_000
|
|
129
|
+
export const TREES_READ = 3
|
|
130
|
+
const MAX_TREE_READS = 400
|
|
131
|
+
const TREES_PARALLEL = 6
|
|
132
|
+
export interface CommitTree { files: string[]; sizes: number[]; cut: boolean }
|
|
133
|
+
export interface TreeStore {
|
|
134
|
+
read(commit: string): Promise<CommitTree | null>
|
|
135
|
+
write(commit: string, tree: CommitTree): Promise<void>
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
type TreeEntry = { type?: unknown; path?: unknown; sha?: unknown; size?: unknown }
|
|
139
|
+
// A file read: its path and its bytes.
|
|
140
|
+
type Blob = [path: string, size: number]
|
|
141
|
+
type TreeListing = (tree: string, recursive: boolean) => Promise<{ entries: TreeEntry[]; truncated: boolean }>
|
|
142
|
+
|
|
143
|
+
export async function repositoryTree(fullName: string, token: string | null, commit: string, kept: TreeStore,
|
|
144
|
+
fetchImpl: typeof fetch = globalThis.fetch): Promise<CommitTree | null> {
|
|
145
|
+
if (!SHA.test(commit)) return null
|
|
146
|
+
const held = await kept.read(commit)
|
|
147
|
+
if (held) return held
|
|
148
|
+
const repo = `https://api.github.com/repos/${fullName.split('/').map(encodeURIComponent).join('/')}`
|
|
149
|
+
const listing: TreeListing = async (tree, recursive) => {
|
|
150
|
+
const data = await githubJson(`${repo}/git/trees/${tree}${recursive ? '?recursive=1' : ''}`, token, fetchImpl) as { tree?: unknown; truncated?: unknown }
|
|
151
|
+
if (!Array.isArray(data?.tree)) throw new GithubApiError(502, 'github-malformed')
|
|
152
|
+
return { entries: data.tree as TreeEntry[], truncated: data.truncated === true }
|
|
153
|
+
}
|
|
154
|
+
let whole: Awaited<ReturnType<TreeListing>>
|
|
155
|
+
try {
|
|
156
|
+
whole = await listing(commit, true)
|
|
157
|
+
} catch (err) {
|
|
158
|
+
if (err instanceof GithubApiError && (err.message === 'github-not-found' || err.message === 'github-status-422')) return null
|
|
159
|
+
throw err
|
|
160
|
+
}
|
|
161
|
+
const files: Blob[] = []
|
|
162
|
+
let cut = false
|
|
163
|
+
if (whole.truncated) cut = await treeByTrees(commit, listing, files)
|
|
164
|
+
else blobsOf(whole.entries, '', files)
|
|
165
|
+
const depth = (path: string) => path.split('/').length
|
|
166
|
+
const byPath = ([a]: Blob, [b]: Blob) => a < b ? -1 : a > b ? 1 : 0
|
|
167
|
+
const nearest = files.length > MAX_TREE_FILES ? files.toSorted((a, b) => depth(a[0]) - depth(b[0]) || byPath(a, b)).slice(0, MAX_TREE_FILES) : files
|
|
168
|
+
const sorted = nearest.toSorted(byPath)
|
|
169
|
+
const tree = { files: sorted.map(([path]) => path), sizes: sorted.map(([, size]) => size), cut: cut || files.length > MAX_TREE_FILES }
|
|
170
|
+
await kept.write(commit, tree)
|
|
171
|
+
return tree
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
// The blobs of a tree's entries, each its path under `prefix` and its bytes
|
|
175
|
+
// (none, as GitHub names none), onto `files`.
|
|
176
|
+
function blobsOf(entries: TreeEntry[], prefix: string, files: Blob[]) {
|
|
177
|
+
for (const item of entries) {
|
|
178
|
+
if (item?.type !== 'blob' || !pathOf(item.path)) continue
|
|
179
|
+
files.push([`${prefix}${item.path as string}`, Number.isSafeInteger(item.size) && (item.size as number) > 0 ? item.size as number : 0])
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
// The files under the commit's tree, `commit`, onto `files`, its trees read
|
|
184
|
+
// a round at a time, those nearest the root first: its own entries, then
|
|
185
|
+
// each tree in it whole, or, where that is cut short, alone in turn, and so
|
|
186
|
+
// on. Each round read whole, whatever answers first, but for trees no file
|
|
187
|
+
// of which could be kept: as deep as, or deeper than, the files nearest the
|
|
188
|
+
// root, as many as MAX_TREE_FILES, of those read (files of a tree are at
|
|
189
|
+
// least a level deeper than it is). As many trees read in all as
|
|
190
|
+
// MAX_TREE_READS, those of a round first in its order. Whether some were
|
|
191
|
+
// left out.
|
|
192
|
+
async function treeByTrees(commit: string, listing: TreeListing, files: Blob[]): Promise<boolean> {
|
|
193
|
+
let cut = false, reads = 1, round = [{ tree: commit, prefix: '', recursive: false }]
|
|
194
|
+
const atDepth: number[] = []
|
|
195
|
+
let counted = 0
|
|
196
|
+
while (round.length > 0) {
|
|
197
|
+
for (; counted < files.length; counted++) {
|
|
198
|
+
const depth = files[counted]![0].split('/').length
|
|
199
|
+
atDepth[depth] = (atDepth[depth] ?? 0) + 1
|
|
200
|
+
}
|
|
201
|
+
// The depth no file deeper than is kept.
|
|
202
|
+
let kept = Number.POSITIVE_INFINITY
|
|
203
|
+
for (let depth = 0, sum = 0; depth < atDepth.length; depth++) {
|
|
204
|
+
sum += atDepth[depth] ?? 0
|
|
205
|
+
if (sum >= MAX_TREE_FILES) {
|
|
206
|
+
kept = depth
|
|
207
|
+
break
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
const asked = round.filter(({ prefix }) => prefix.split('/').length - 1 < kept).slice(0, Math.max(0, MAX_TREE_READS - reads))
|
|
211
|
+
cut ||= asked.length < round.length
|
|
212
|
+
reads += asked.length
|
|
213
|
+
const listed: Awaited<ReturnType<TreeListing>>[] = []
|
|
214
|
+
await eachOf([...asked.keys()], TREES_PARALLEL, async at => { listed[at] = await listing(asked[at]!.tree, asked[at]!.recursive) })
|
|
215
|
+
const next: typeof round = []
|
|
216
|
+
for (const [at, { tree, prefix, recursive }] of asked.entries()) {
|
|
217
|
+
const { entries, truncated } = listed[at]!
|
|
218
|
+
if (truncated && recursive) {
|
|
219
|
+
next.push({ tree, prefix, recursive: false })
|
|
220
|
+
continue
|
|
221
|
+
}
|
|
222
|
+
cut ||= truncated
|
|
223
|
+
blobsOf(entries, prefix, files)
|
|
224
|
+
if (recursive) continue
|
|
225
|
+
for (const item of entries) {
|
|
226
|
+
const path = pathOf(item?.path)
|
|
227
|
+
if (item?.type === 'tree' && path && typeof item.sha === 'string' && SHA.test(item.sha)) next.push({ tree: item.sha, prefix: `${prefix}${path}/`, recursive: true })
|
|
228
|
+
}
|
|
229
|
+
}
|
|
230
|
+
round = next
|
|
231
|
+
}
|
|
232
|
+
return cut
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
// The files commit `commit` holds within the directory `path` ('' the whole
|
|
236
|
+
// repository), as repositoryTree reads them: its whole tree's within it; where
|
|
237
|
+
// that is cut short, some of the directory's perhaps among those left out,
|
|
238
|
+
// the directory's own tree read so (directoryTree), kept by its id, the files
|
|
239
|
+
// nearest it kept. Null for a commit GitHub has none of.
|
|
240
|
+
export async function directoryFiles(fullName: string, token: string | null, commit: string, path: string, kept: TreeStore,
|
|
241
|
+
fetchImpl: typeof fetch = globalThis.fetch): Promise<CommitTree | null> {
|
|
242
|
+
const whole = await repositoryTree(fullName, token, commit, kept, fetchImpl)
|
|
243
|
+
if (!whole || path === '' || !whole.cut) return whole && treeWithin(whole, path)
|
|
244
|
+
const id = await directoryTree(fullName, token, commit, path, fetchImpl)
|
|
245
|
+
const own = id ? await repositoryTree(fullName, token, id, kept, fetchImpl) : null
|
|
246
|
+
return own ? { ...own, files: own.files.map(file => `${path}/${file}`) } : treeWithin(whole, path)
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
// The id of the tree at `path` in commit `commit`, read a level at a time
|
|
250
|
+
// (GET /repos/:owner/:repo/git/trees/:tree, its own entries alone); null
|
|
251
|
+
// where it has none there, or GitHub has no such commit.
|
|
252
|
+
async function directoryTree(fullName: string, token: string | null, commit: string, path: string, fetchImpl: typeof fetch): Promise<string | null> {
|
|
253
|
+
const repo = `https://api.github.com/repos/${fullName.split('/').map(encodeURIComponent).join('/')}`
|
|
254
|
+
let tree = commit
|
|
255
|
+
for (const name of path.split('/')) {
|
|
256
|
+
let data: { tree?: unknown }
|
|
257
|
+
try {
|
|
258
|
+
data = await githubJson(`${repo}/git/trees/${tree}`, token, fetchImpl) as typeof data
|
|
259
|
+
} catch (err) {
|
|
260
|
+
if (err instanceof GithubApiError && (err.message === 'github-not-found' || err.message === 'github-status-422')) return null
|
|
261
|
+
throw err
|
|
262
|
+
}
|
|
263
|
+
if (!Array.isArray(data?.tree)) throw new GithubApiError(502, 'github-malformed')
|
|
264
|
+
const entry = (data.tree as TreeEntry[]).find(item => item?.path === name && item.type === 'tree')
|
|
265
|
+
if (typeof entry?.sha !== 'string' || !SHA.test(entry.sha)) return null
|
|
266
|
+
tree = entry.sha
|
|
267
|
+
}
|
|
268
|
+
return tree
|
|
269
|
+
}
|
|
270
|
+
|
|
271
|
+
// The files of a tree within the directory `path` ('' the whole repository).
|
|
272
|
+
export function treeWithin({ files, sizes, cut }: CommitTree, path: string): CommitTree {
|
|
273
|
+
if (path === '') return { files, sizes, cut }
|
|
274
|
+
const within = [...files.keys()].filter(at => files[at]!.startsWith(`${path}/`))
|
|
275
|
+
return { files: within.map(at => files[at]!), sizes: within.map(at => sizes[at]!), cut }
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
// The commits a request names (`shas`), each once, as many as
|
|
279
|
+
// CHANGES_ASKED; null for none, or for one that isn't a commit id.
|
|
280
|
+
export function changesAsked(shas: string | null): string[] | null {
|
|
281
|
+
if (!shas) return null
|
|
282
|
+
const asked = [...new Set(shas.split(','))]
|
|
283
|
+
return asked.length <= CHANGES_ASKED && asked.every(sha => SHA.test(sha)) ? asked : null
|
|
284
|
+
}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
// Reading a directory of a repository at a commit for the managed code viewer
|
|
2
|
+
// (GET /api/admin/repositories/code): its tree's tarball as GitHub archives
|
|
3
|
+
// it, verified against the tree's id and kept in upstream's disk cache as
|
|
4
|
+
// bundle builds keep theirs (getRepoTreeTarball), and its files as the npm
|
|
5
|
+
// viewer reads a package's (npm-packages.ts npmFileRows). Readers asking for
|
|
6
|
+
// the same directory meanwhile share its body, a load among the npm viewer's
|
|
7
|
+
// active ones (npm-loads.ts sharedLoad).
|
|
8
|
+
import { Buffer } from 'node:buffer'
|
|
9
|
+
import { encodeBrotli } from './brotli.ts'
|
|
10
|
+
import { MAX_NPM_PACKAGE_BYTES, MAX_NPM_PACKAGE_FILES, NpmPackageError, npmFileRows } from './npm-packages.ts'
|
|
11
|
+
import { type NpmLoad, readTarballFiles, sharedLoad } from './npm-loads.ts'
|
|
12
|
+
|
|
13
|
+
// As much as a package may hold: the viewer holds every file in memory.
|
|
14
|
+
export const MAX_REPOSITORY_CODE_FILES = MAX_NPM_PACKAGE_FILES
|
|
15
|
+
export const MAX_REPOSITORY_CODE_BYTES = MAX_NPM_PACKAGE_BYTES
|
|
16
|
+
|
|
17
|
+
// Whether a directory's files fit, by GitHub's listing of its tree and every
|
|
18
|
+
// tree under it (repository-browser.ts repositoryTreeFiles): asked before
|
|
19
|
+
// its tarball is, which may run to hundreds of MiB. One GitHub cut short
|
|
20
|
+
// (null) has too many.
|
|
21
|
+
export function repositoryCodeFits(files: { files: number; bytes: number } | null): boolean {
|
|
22
|
+
return files !== null && files.files <= MAX_REPOSITORY_CODE_FILES && files.bytes <= MAX_REPOSITORY_CODE_BYTES
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
// The directory read: the repository by its id and name, the commit, the
|
|
26
|
+
// directory (`''` for the root) and its tree's id.
|
|
27
|
+
export interface RepositoryCodeInput { repoId: number; repo: string; commit: string; path: string; tree: string }
|
|
28
|
+
|
|
29
|
+
// A package's refusals, as a directory's: past the bounds, or an archive
|
|
30
|
+
// @preventive/archive refuses, as it does one holding a symlink that climbs
|
|
31
|
+
// past the repository's root, or an absolute one.
|
|
32
|
+
const DIRECTORY_ERRORS: Record<string, [number, string]> = { 'package-too-large': [413, 'directory-too-large'], 'bad-tarball': [422, 'directory-unreadable'] }
|
|
33
|
+
const directoryError = (err: unknown) => {
|
|
34
|
+
const as = err instanceof NpmPackageError ? DIRECTORY_ERRORS[err.message] : undefined
|
|
35
|
+
return as ? new NpmPackageError(...as) : err
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
// The directory as the viewer reads it, as brotli-encoded JSON: `{ repoId,
|
|
39
|
+
// repo, commit, path, tree, files }`, its files as npmFileRows gives them,
|
|
40
|
+
// by their paths in the directory, from `tarball`, the tree's.
|
|
41
|
+
export function loadRepositoryCodeBody(input: RepositoryCodeInput, tarball: () => Promise<Uint8Array>): NpmLoad<Buffer> {
|
|
42
|
+
const { repoId, repo, commit, path, tree } = input
|
|
43
|
+
return sharedLoad(`repository ${repoId} ${repo} ${commit} ${path} ${tree}`, async () => {
|
|
44
|
+
let files
|
|
45
|
+
// A symlink may reach the repository's root, as a monorepo package's
|
|
46
|
+
// LICENSE links the root's, and no further: the directory's depth, less
|
|
47
|
+
// the level the archive's root already stands above its top directory.
|
|
48
|
+
try { files = npmFileRows(await readTarballFiles(await tarball(), { symlinksAbove: path.split('/').length - 1 })) }
|
|
49
|
+
catch (err) { throw directoryError(err) }
|
|
50
|
+
return encodeBrotli(Buffer.from(JSON.stringify({ repoId, repo, commit, path, tree, files })))
|
|
51
|
+
}, 'repository-busy')
|
|
52
|
+
}
|