-
Notifications
You must be signed in to change notification settings - Fork 22
/
pollapoYml.ts
365 lines (339 loc) · 11 KB
/
pollapoYml.ts
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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
import { parse as parseYaml } from "https://deno.land/std@0.147.0/encoding/yaml.ts";
import {
emptyDir,
ensureDir,
exists,
} from "https://deno.land/std@0.147.0/fs/mod.ts";
import { red, yellow } from "https://deno.land/std@0.147.0/fmt/colors.ts";
import * as path from "https://deno.land/std@0.147.0/path/mod.ts";
import { stripComponents, unzip } from "../../misc/archive/zip.ts";
import { fetchArchive, fetchCommitStatus } from "../../misc/github/index.ts";
import backoff from "./misc/exponential-backoff.ts";
import { getRevType } from "./rev.ts";
import { YAMLError } from "https://deno.land/std@0.147.0/encoding/_yaml/error.ts";
export type PollapoYml = {
repo?: string;
deps?: string[];
root?: PollapoRoot;
} | undefined;
export interface PollapoDep {
user: string;
repo: string;
rev: string;
}
export type PollapoDepFrag =
& Omit<PollapoDep, "rev">
& Partial<Pick<PollapoDep, "rev">>;
export interface PollapoRoot {
lock?: PollapoRootLockTable;
}
export interface PollapoRootLockTable {
[dep: string]: string; // value: commit hash
}
export interface PollapoRootReplaceFileOption {
[optionName: string]: PollapoRootReplaceFileOptionItem;
}
export interface PollapoRootReplaceFileOptionItem {
regex: string;
value: string;
}
export interface GetPollapoYmlConfig {
dep: PollapoDep;
cacheDir: string;
}
export async function getPollapoYml(
config?: GetPollapoYmlConfig,
): Promise<PollapoYml> {
const ymlPath = config
? getYmlPath(config.cacheDir, config.dep)
: "pollapo.yml";
return loadPollapoYml(ymlPath);
}
export async function loadPollapoYml(ymlPath: string): Promise<PollapoYml> {
try {
const pollapoYmlText = await Deno.readTextFile(ymlPath);
return parseYaml(pollapoYmlText) as PollapoYml;
} catch (err) {
if (err instanceof YAMLError) throw new PollapoYmlMalformedError(ymlPath);
else throw new PollapoYmlNotFoundError(ymlPath);
}
}
export class PollapoYmlNotFoundError extends Error {
constructor(public ymlPath: string) {
super(`"${red(path.resolve(ymlPath))}" not found.`);
}
}
export class PollapoYmlMalformedError extends Error {
constructor(public ymlPath: string) {
super(`"${yellow(path.resolve(ymlPath))}" is malformed`);
}
}
export function* deps(pollapoYml: PollapoYml) {
for (const dep of pollapoYml?.deps ?? []) yield parseDep(dep);
}
export function parseDep(dep: string): PollapoDep {
const match = /(?<user>.+?)\/(?<repo>.+?)@(?<rev>.+)/.exec(dep);
if (!match) throw new Error("invalid dep string: " + dep);
return match.groups as unknown as PollapoDep;
}
export function parseDepFrag(dep: string): PollapoDepFrag {
const match = /(?<user>.+?)\/(?<repo>.+?)(@(?<rev>.+))?$/.exec(dep);
if (!match) throw new Error("invalid dep string: " + dep);
return match.groups as unknown as PollapoDepFrag;
}
export function depToString(dep: PollapoDep): string {
return `${dep.user}/${dep.repo}@${dep.rev}`;
}
export function getZipPath(cacheDir: string, dep: PollapoDep): string {
return getCachePath(cacheDir, dep) + ".zip";
}
export function getYmlPath(cacheDir: string, dep: PollapoDep): string {
return getCachePath(cacheDir, dep) + ".yml";
}
function getCachePath(cacheDir: string, dep: PollapoDep): string {
return path.resolve(
cacheDir,
encode(dep.user),
encode(dep.repo) + "@" + encode(dep.rev),
);
}
// https://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words
function encode(rev: string): string {
return rev.replaceAll(
/[%\\/:*"<>|]/g,
(c) => `%${c.charCodeAt(0).toString(16).toUpperCase()}`,
);
}
export interface CacheDepsConfig {
pollapoYml: PollapoYml;
clean: boolean;
cacheDir: string;
fetchCommitHash: (dep: PollapoDep) => Promise<string>;
fetchZip: (dep: PollapoDep) => Promise<Uint8Array>;
}
export type CacheDepsTask =
| CacheDepsTaskUseCache
| CacheDepsTaskUseLockedCommitHash
| CacheDepsTaskCheckCommitHash
| CacheDepsTaskDownload;
interface CacheDepsTaskBase<TTaskType extends string, TResult> {
type: TTaskType;
dep: PollapoDep;
promise: Promise<TResult>;
}
export type CacheDepsTaskUseCache = CacheDepsTaskBase<"use-cache", void>;
export type CacheDepsTaskUseLockedCommitHash = CacheDepsTaskBase<
"use-locked-commit-hash",
string
>;
export type CacheDepsTaskCheckCommitHash = CacheDepsTaskBase<
"check-commit-hash",
string
>;
export type CacheDepsTaskDownload = CacheDepsTaskBase<
"download",
CacheDepsTaskDownloadResult
>;
export interface CacheDepsTaskDownloadResult {
zip: Uint8Array;
pollapoYmlText: string;
pollapoYml: PollapoYml;
}
export async function* cacheDeps(
config: CacheDepsConfig,
): AsyncGenerator<CacheDepsTask> {
const { pollapoYml, clean, cacheDir, fetchZip, fetchCommitHash } = config;
if (clean) await emptyDir(cacheDir);
const lockTable = pollapoYml?.root?.lock ?? {};
const queue = [...deps(pollapoYml)];
let dep: PollapoDep;
const visitedDeps: { [visitedDep: string]: true } = {};
while (dep = queue.shift()!) {
const ymlPath = getYmlPath(cacheDir, dep);
const revType = getRevType(dep.rev);
const depString = depToString(dep);
if (visitedDeps[depString]) continue;
visitedDeps[depString] = true;
if ((revType !== "branch") && await exists(ymlPath)) {
yield { type: "use-cache", dep, promise: Promise.resolve() };
const pollapoYmlText = await Deno.readTextFile(ymlPath);
const pollapoYml = parseYaml(pollapoYmlText) as PollapoYml;
queue.push(...deps(pollapoYml));
continue;
}
await ensureDir(path.resolve(cacheDir, dep.user));
if (revType === "branch") {
const fetchingCommitHash = depString in lockTable
? Promise.resolve(lockTable[depString])
: fetchCommitHash(dep);
const taskType = depString in lockTable
? "use-locked-commit-hash"
: "check-commit-hash";
yield { type: taskType, dep, promise: fetchingCommitHash };
const commitHash = await fetchingCommitHash;
queue.push({ ...dep, rev: commitHash });
await unlink(dep);
try {
await link(dep, commitHash);
} catch (err) {
if (Deno.build.os === "windows") {
// https://docs.microsoft.com/en-us/windows/win32/debug/system-error-codes--1300-1699-
if (err?.message?.includes("(os error 1314)")) {
throw new PollapoWindowsPrivilegeNotHeldError();
}
}
throw err;
}
} else {
const downloading = download(dep);
yield { type: "download", dep, promise: downloading };
const { zip, pollapoYmlText, pollapoYml } = await downloading;
queue.push(...deps(pollapoYml));
await cache(dep, zip, pollapoYmlText);
}
}
async function download(
dep: PollapoDep,
): Promise<CacheDepsTaskDownloadResult> {
const zip = await fetchZip(dep);
const pollapoYmlText = await extractPollapoYml(zip);
const pollapoYml = parseYaml(pollapoYmlText) as PollapoYml;
return { zip, pollapoYmlText, pollapoYml };
}
async function unlink(dep: PollapoDep) {
try {
await Promise.all([
Deno.remove(getZipPath(cacheDir, dep)),
Deno.remove(getYmlPath(cacheDir, dep)),
]);
} catch {
// Ignore if file does not exist
}
}
async function link(dep: PollapoDep, rev: string) {
const targetDep: PollapoDep = { ...dep, rev };
await Promise.all([
Deno.symlink(
getZipPath(cacheDir, targetDep),
getZipPath(cacheDir, dep),
{ type: "file" },
),
Deno.symlink(
getYmlPath(cacheDir, targetDep),
getYmlPath(cacheDir, dep),
{ type: "file" },
),
]);
}
async function cache(
dep: PollapoDep,
zip: Uint8Array,
pollapoYmlText: string,
) {
const zipPath = getZipPath(cacheDir, dep);
const ymlPath = getYmlPath(cacheDir, dep);
await Promise.all([
Deno.writeFile(zipPath, zip),
Deno.writeTextFile(ymlPath, pollapoYmlText),
]);
}
}
export class PollapoWindowsPrivilegeNotHeldError extends Error {
constructor() {
super(
"A required privilege is not held by the client. Please run the command as administrator.",
);
}
}
export function lock<T extends (PollapoDep | undefined) = PollapoDep>(
lockTable: PollapoRootLockTable,
dep: T,
): T {
if (!dep) return dep;
const depString = depToString(dep!);
if (depString in lockTable) return { ...dep!, rev: lockTable[depString] };
return dep;
}
export interface AnalyzeDepsConfig {
pollapoYml: PollapoYml;
cacheDir: string;
}
export interface AnalyzeDepsResult {
[repo: string]: AnalyzeDepsResultRevs;
}
export interface AnalyzeDepsResultRevs {
[rev: string]: AnalyzeDepsResultRev;
}
export interface AnalyzeDepsResultRev {
froms: string[];
}
export async function analyzeDeps(
config: AnalyzeDepsConfig,
): Promise<AnalyzeDepsResult> {
type Dep = PollapoDep & { from: string };
const result: AnalyzeDepsResult = {};
const { pollapoYml, cacheDir } = config;
const lockTable = pollapoYml?.root?.lock ?? {};
const queue: Dep[] = [...deps(pollapoYml)].map((dep) => ({
...dep,
from: "<root>",
}));
let dep: Dep;
while (dep = queue.shift()!) {
const repo = `${dep.user}/${dep.repo}`;
const froms = result[repo]?.[dep.rev]?.froms ?? [];
const revs: AnalyzeDepsResultRevs = result[repo] ?? {};
froms.push(dep.from);
revs[dep.rev] = { froms };
result[repo] = revs;
const pollapoYml = await getPollapoYml({
dep: lock(lockTable, dep),
cacheDir,
});
for (const innerDep of deps(pollapoYml)) {
if (depToString(dep) === depToString(innerDep)) continue;
queue.push({ ...innerDep, from: depToString(dep) });
}
}
return result;
}
export function sanitizeDeps(pollapoYml: PollapoYml): PollapoYml {
const deps = pollapoYml?.deps ?? [];
const result: PollapoYml = { ...pollapoYml };
if (deps.length === 0) {
delete result.deps;
} else {
result.deps = [...new Set(result.deps)].sort();
}
if (result.root?.lock) {
result.root.lock = sortObjectKeys(result.root.lock);
if (!Object.keys(result.root.lock).length) delete result.root.lock;
}
if (result.root && !Object.keys(result.root).length) delete result.root;
return result;
}
function sortObjectKeys(obj: Record<string, any>): Record<string, any> {
const result: Record<string, any> = {};
for (const key of Object.keys(obj).sort()) result[key] = obj[key];
return result;
}
export function getFetchCommitHash(token?: string) {
return async function fetchCommitHash(dep: PollapoDep): Promise<string> {
const res = await backoff(() => fetchCommitStatus({ token, ...dep }));
return res.sha;
};
}
export function getFetchZip(token?: string) {
return async function fetchZip(dep: PollapoDep): Promise<Uint8Array> {
const res = await backoff(() =>
fetchArchive({ type: "zip", token, ...dep })
);
return new Uint8Array(await res.arrayBuffer());
};
}
async function extractPollapoYml(zip: Uint8Array): Promise<string> {
const files = stripComponents(await unzip(zip), 1);
const pollapoYml = files["pollapo.yml"];
if (!pollapoYml) return "";
return pollapoYml.async("text");
}