forked from w3c/spec-prod
-
Notifications
You must be signed in to change notification settings - Fork 0
/
build.ts
299 lines (264 loc) · 8.54 KB
/
build.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
import * as path from "path";
import { copyFile, mkdir, readFile, writeFile, unlink } from "fs/promises";
import fetch from "node-fetch";
import { getAllSubResources, ResourceType } from "subresources";
import { env, exit, setOutput, sh, unique } from "./utils.js";
import { deepEqual, StaticServer } from "./utils.js";
import { PUPPETEER_ENV } from "./constants.js";
import { BasicBuildOptions } from "./prepare-build.js";
import { ProcessedInput } from "./prepare.js";
type Input = ProcessedInput["build"];
type ConfigOverride = Input["configOverride"]["gh" | "w3c"];
type BuildSuffix = "common" | "gh" | "w3c";
/**
* @example
* ```js
* let destination = "my-spec/index.html"; // then:
* root = process.cwd() + BuildSuffix
* dir = "my-spec"
* file = "index.html"
* dest = path.join(process.cwd() + BuildSuffix, "my-spec")
* ```
*/
export interface BuildResult {
root: string;
dir: string;
file: string;
dest: string;
}
const rel = (p: string) => path.relative(process.cwd(), p);
const tmpOutputFile = (source: Input["source"]) => source.path + ".built.html";
if (module === require.main) {
const input: Input = JSON.parse(env("INPUTS_BUILD"));
main(input).catch(err => exit(err.message || "Failed", err.code));
}
export default async function main({
toolchain,
source,
destination,
flags,
configOverride,
}: Input) {
const input: BasicBuildOptions = { toolchain, source, destination };
if (deepEqual(configOverride.gh, configOverride.w3c)) {
const out = await build(input, flags, null, "common");
return { ...setOutput("gh", out), ...setOutput("w3c", out) };
}
const confGh = configOverride.gh;
const outGh = await build(input, flags, confGh, "gh");
const confW3C = configOverride.w3c;
const outW3C = await build(input, flags, confW3C, "w3c");
return { ...setOutput("gh", outGh), ...setOutput("w3c", outW3C) };
}
async function build(
input: BasicBuildOptions,
additionalFlags: Input["flags"],
conf: ConfigOverride,
suffix: BuildSuffix,
): Promise<BuildResult> {
const { toolchain, source, destination } = input;
console.group(
`[INFO] Build ${toolchain} document "${source.path}" (${suffix})…`,
);
switch (toolchain) {
case "respec":
await buildReSpec(source, additionalFlags, conf);
break;
case "bikeshed":
await buildBikeshed(source, additionalFlags, conf);
break;
default:
throw new Error(`Unknown "TOOLCHAIN": "${toolchain}"`);
}
const res = await copyRelevantAssets(source, destination, suffix);
console.groupEnd();
return res;
}
async function buildReSpec(
source: Input["source"],
additionalFlags: Input["flags"],
conf: ConfigOverride,
) {
const flags = additionalFlags.join(" ");
const server = await new StaticServer().start();
const src = new URL(source.path, server.url);
for (const [key, val] of Object.entries(conf || {})) {
src.searchParams.set(key, val);
}
const outFile = tmpOutputFile(source);
try {
await sh(`respec -s "${src}" -o "${outFile}" --verbose -t 20 ${flags}`, {
output: "stream",
env: PUPPETEER_ENV,
});
} finally {
await server.stop();
}
}
async function buildBikeshed(
source: Input["source"],
additionalFlags: Input["flags"],
conf: ConfigOverride,
) {
const metadataFlags = Object.entries(conf || {})
.map(([key, val]) => `--md-${key.replace(/\s+/g, "-")}="${val}"`)
.join(" ");
const flags = additionalFlags.join(" ");
const outFile = tmpOutputFile(source);
await sh(
`bikeshed ${flags} spec "${source.path}" "${outFile}" ${metadataFlags}`,
"stream",
);
}
async function copyRelevantAssets(
source: Input["source"],
destination: Input["destination"],
suffix: BuildSuffix,
): Promise<BuildResult> {
const rootDir = path.join(process.cwd() + `.${suffix}`);
const destinationDir = path.join(rootDir, destination.dir);
const destinationFile = path.join(destinationDir, destination.file);
const tmpOutFile = tmpOutputFile(source);
const assets = await findAssetsToCopy(source);
await copyLocalAssets(assets.local, rootDir);
const newRemoteURLs = await downloadRemoteAssets(
assets.remote,
destinationDir,
);
// Copy output file to the publish directory
if (!newRemoteURLs.length) {
await copy(tmpOutFile, destinationFile);
} else {
console.log(`Replacing instances of remote URLs with download asset URLs…`);
let text = await readFile(tmpOutFile, "utf8");
for (const urls of newRemoteURLs) {
text = replaceAll(urls.old, urls.new, text);
}
await mkdir(path.dirname(destinationFile), { recursive: true });
await writeFile(destinationFile, text, "utf8");
}
await unlink(tmpOutFile);
// List all files in output directory
await sh(`ls -R`, { output: "buffer", cwd: destinationDir });
return {
root: rootDir,
dest: destinationDir,
dir: destination.dir,
file: destination.file,
};
}
async function findAssetsToCopy(source: Input["source"]) {
console.groupCollapsed(`[INFO] Finding relevant assets…`);
let localAssets: string[] = [];
let remoteAssets: URL[] = [];
const server = await new StaticServer().start();
const isLocalAsset = (url: URL) => url.origin === server.url.origin;
const remoteAssetRules: ((url: URL, type: ResourceType) => boolean)[] = [
(url: URL) => url.origin === "https://user-images.githubusercontent.com",
];
process.env["PUPPETEER_EXECUTABLE_PATH"] =
PUPPETEER_ENV.PUPPETEER_EXECUTABLE_PATH;
const mainPage = urlToPage(new URL(tmpOutputFile(source), server.url));
const pages = new Set([mainPage]);
for (const page of pages) {
const rootUrl = new URL(page);
console.log(`[INFO] From ${rootUrl.pathname}…`);
const { ok, headers } = await fetch(rootUrl);
if (!ok || !headers.get("content-type")?.includes("text/html")) {
console.log(
`[WARNING] Failed to fetch ${rootUrl.pathname}. Some assets might be missing.`,
);
continue;
}
for await (const res of getAllSubResources(rootUrl, { links: true })) {
const url = new URL(res.url);
if (isLocalAsset(url) && res.type === "link") {
const nextPage = urlToPage(url);
if (!pages.has(nextPage)) {
pages.add(nextPage);
localAssets.push(url.pathname);
}
} else if (isLocalAsset(url)) {
localAssets.push(url.pathname);
} else if (remoteAssetRules.some(matcher => matcher(url, res.type))) {
remoteAssets.push(url);
}
}
}
localAssets = unique(localAssets);
remoteAssets = unique(remoteAssets, url => url.href);
console.log("Local assets to be copied:", trimList(localAssets));
console.log(
"Remote assets to be downloaded:",
trimList(remoteAssets.map(u => u.href)),
);
console.groupEnd();
await server.stop();
return { local: localAssets.sort(), remote: remoteAssets.sort() };
}
async function copyLocalAssets(assets: string[], destinationDir: string) {
console.groupCollapsed(`Copying ${assets.length} local files…`);
await Promise.all(
assets.map(asset => copy(asset, path.join(destinationDir, asset))),
);
console.groupEnd();
}
async function downloadRemoteAssets(urls: URL[], destinationDir: string) {
console.groupCollapsed(`Downloading ${urls.length} remote files…`);
const result = await Promise.all(
urls.map(url => download(url, destinationDir)),
);
console.groupEnd();
return result;
}
// ///////////////////////
// Utils
// ///////////////////////
async function copy(src: string, dst: string) {
src = path.join(process.cwd(), src);
try {
await mkdir(path.dirname(dst), { recursive: true });
await copyFile(src, dst);
} catch (error) {
const msg = `Copy: ${rel(src)} ➡ ${rel(dst)}`;
console.log("[WARNING]", msg, error.message);
}
}
async function download(url: URL, destinationDir: string) {
const href = `downloaded-assets/${url.host}${url.pathname}`;
const destination = path.join(destinationDir, href.replace(/\//g, path.sep));
try {
const res = await fetch(url);
if (!res.ok) {
throw new Error(`Status: ${res.status}`);
}
const text = await res.buffer();
await mkdir(path.dirname(destination), { recursive: true });
await writeFile(destination, text, "utf8");
} catch (error) {
const msg = `Download: ${url.href} ➡ ${rel(destination)}`;
console.log("[WARNING]", msg, error.message);
}
return { old: url.href, new: href };
}
// https://www.npmjs.com/package/replaceall
function replaceAll(replaceThis: string, withThis: string, inThis: string) {
withThis = withThis.replace(/\$/g, "$$$$");
return inThis.replace(
new RegExp(
replaceThis.replace(
/([\/\,\!\\\^\$\{\}\[\]\(\)\.\*\+\?\|<>\-\&])/g,
"\\$&",
),
"g",
),
withThis,
);
}
function trimList(list: string[], len = 8) {
if (list.length < len) return list;
return list.slice(0, len).concat([`${list.length - len} more..`]);
}
function urlToPage(url: URL) {
return new URL(url.pathname, url.origin).href;
}