-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
install.ts
302 lines (272 loc) · 10.6 KB
/
install.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
import fs = require('fs');
import os = require('os');
import path = require('path');
import zlib = require('zlib');
import https = require('https');
import child_process = require('child_process');
declare const ESBUILD_VERSION: string;
const version = ESBUILD_VERSION;
const binPath = path.join(__dirname, 'bin', 'esbuild');
async function installBinaryFromPackage(name: string, fromPath: string, toPath: string): Promise<void> {
// Try to install from the cache if possible
const cachePath = getCachePath(name);
try {
// Copy from the cache
fs.copyFileSync(cachePath, toPath);
fs.chmodSync(toPath, 0o755);
// Verify that the binary is the correct version
validateBinaryVersion(toPath);
// Mark the cache entry as used for LRU
const now = new Date;
fs.utimesSync(cachePath, now, now);
return;
} catch {
}
// Next, try to install using npm. This should handle various tricky cases
// such as environments where requests to npmjs.org will hang (in which case
// there is probably a proxy and/or a custom registry configured instead).
let buffer: Buffer | undefined;
let didFail = false;
try {
buffer = installUsingNPM(name, fromPath);
} catch (err) {
didFail = true;
console.error(`Trying to install "${name}" using npm`);
console.error(`Failed to install "${name}" using npm: ${err && err.message || err}`);
}
// If that fails, the user could have npm configured incorrectly or could not
// have npm installed. Try downloading directly from npm as a last resort.
if (!buffer) {
const url = `https://registry.npmjs.org/${name}/-/${name}-${version}.tgz`;
console.error(`Trying to download ${JSON.stringify(url)}`);
try {
buffer = extractFileFromTarGzip(await fetch(url), fromPath);
} catch (err) {
console.error(`Failed to download ${JSON.stringify(url)}: ${err && err.message || err}`);
}
}
// Give up if none of that worked
if (!buffer) {
console.error(`Install unsuccessful`);
process.exit(1);
}
// Write out the binary executable that was extracted from the package
fs.writeFileSync(toPath, buffer, { mode: 0o755 });
// Verify that the binary is the correct version
try {
validateBinaryVersion(toPath);
} catch (err) {
console.error(`The version of the downloaded binary is incorrect: ${err && err.message || err}`);
console.error(`Install unsuccessful`);
process.exit(1);
}
// Also try to cache the file to speed up future installs
try {
fs.mkdirSync(path.dirname(cachePath), { recursive: true });
fs.copyFileSync(toPath, cachePath);
cleanCacheLRU(cachePath);
} catch {
}
if (didFail) console.error(`Install successful`);
}
function validateBinaryVersion(binaryPath: string): void {
let stdout;
try {
stdout = child_process.execFileSync(binaryPath, ['--version']).toString().trim();
} catch (err) {
if (platformKey === 'darwin arm64 LE')
throw new Error(`${err && err.message || err}
This install script is trying to install the x64 esbuild executable because the
arm64 esbuild executable is not available yet. Running this executable requires
the Rosetta 2 binary translator. Please make sure you have Rosetta 2 installed
before installing esbuild.
`);
throw err;
}
if (stdout !== version) {
throw new Error(`Expected ${JSON.stringify(version)} but got ${JSON.stringify(stdout)}`);
}
}
function getCachePath(name: string): string {
const home = os.homedir();
const common = ['esbuild', 'bin', `${name}@${version}`];
if (process.platform === 'darwin') return path.join(home, 'Library', 'Caches', ...common);
if (process.platform === 'win32') return path.join(home, 'AppData', 'Local', 'Cache', ...common);
return path.join(home, '.cache', ...common);
}
function cleanCacheLRU(fileToKeep: string): void {
// Gather all entries in the cache
const dir = path.dirname(fileToKeep);
const entries: { path: string, mtime: Date }[] = [];
for (const entry of fs.readdirSync(dir)) {
const entryPath = path.join(dir, entry);
try {
const stats = fs.statSync(entryPath);
entries.push({ path: entryPath, mtime: stats.mtime });
} catch {
}
}
// Only keep the most recent entries
entries.sort((a, b) => +b.mtime - +a.mtime);
for (const entry of entries.slice(5)) {
try {
fs.unlinkSync(entry.path);
} catch {
}
}
}
function fetch(url: string): Promise<Buffer> {
return new Promise((resolve, reject) => {
https.get(url, res => {
if ((res.statusCode === 301 || res.statusCode === 302) && res.headers.location)
return fetch(res.headers.location).then(resolve, reject);
if (res.statusCode !== 200)
return reject(new Error(`Server responded with ${res.statusCode}`));
let chunks: Buffer[] = [];
res.on('data', chunk => chunks.push(chunk));
res.on('end', () => resolve(Buffer.concat(chunks)));
}).on('error', reject);
});
}
function extractFileFromTarGzip(buffer: Buffer, file: string): Buffer {
try {
buffer = zlib.unzipSync(buffer);
} catch (err) {
throw new Error(`Invalid gzip data in archive: ${err && err.message || err}`);
}
let str = (i: number, n: number) => String.fromCharCode(...buffer.subarray(i, i + n)).replace(/\0.*$/, '');
let offset = 0;
file = `package/${file}`;
while (offset < buffer.length) {
let name = str(offset, 100);
let size = parseInt(str(offset + 124, 12), 8);
offset += 512;
if (!isNaN(size)) {
if (name === file) return buffer.subarray(offset, offset + size);
offset += (size + 511) & ~511;
}
}
throw new Error(`Could not find ${JSON.stringify(file)} in archive`);
}
function installUsingNPM(name: string, file: string): Buffer {
const installDir = path.join(os.tmpdir(), 'esbuild-' + Math.random().toString(36).slice(2));
fs.mkdirSync(installDir, { recursive: true });
fs.writeFileSync(path.join(installDir, 'package.json'), '{}');
// Erase "npm_config_global" so that "npm install --global esbuild" works.
// Otherwise this nested "npm install" will also be global, and the install
// will deadlock waiting for the global installation lock.
const env = { ...process.env, npm_config_global: undefined };
child_process.execSync(`npm install --loglevel=error --prefer-offline --no-audit --progress=false ${name}@${version}`,
{ cwd: installDir, stdio: 'pipe', env });
const buffer = fs.readFileSync(path.join(installDir, 'node_modules', name, file));
try {
removeRecursive(installDir);
} catch (e) {
// Removing a file or directory can randomly break on Windows, returning
// EBUSY for an arbitrary length of time. I think this happens when some
// other program has that file or directory open (e.g. an anti-virus
// program). This is fine on Unix because the OS just unlinks the entry
// but keeps the reference around until it's unused. In this case we just
// ignore errors because this directory is in a temporary directory, so in
// theory it should get cleaned up eventually anyway.
}
return buffer;
}
function removeRecursive(dir: string): void {
for (const entry of fs.readdirSync(dir)) {
const entryPath = path.join(dir, entry);
let stats;
try {
stats = fs.lstatSync(entryPath);
} catch (e) {
continue; // Guard against https://github.com/nodejs/node/issues/4760
}
if (stats.isDirectory()) removeRecursive(entryPath);
else fs.unlinkSync(entryPath);
}
fs.rmdirSync(dir);
}
function isYarnBerryOrNewer(): boolean {
const { npm_config_user_agent } = process.env;
if (npm_config_user_agent) {
const match = npm_config_user_agent.match(/yarn\/(\d+)/);
if (match && match[1]) {
return parseInt(match[1], 10) >= 2;
}
}
return false;
}
function installDirectly(name: string) {
if (process.env.ESBUILD_BIN_PATH_FOR_TESTS) {
fs.unlinkSync(binPath);
fs.symlinkSync(process.env.ESBUILD_BIN_PATH_FOR_TESTS, binPath);
validateBinaryVersion(process.env.ESBUILD_BIN_PATH_FOR_TESTS);
} else {
installBinaryFromPackage(name, 'bin/esbuild', binPath)
.catch(e => setImmediate(() => { throw e; }));
}
}
function installWithWrapper(name: string, fromPath: string, toPath: string): void {
fs.writeFileSync(
binPath,
`#!/usr/bin/env node
const path = require('path');
const esbuild_exe = path.join(__dirname, '..', ${JSON.stringify(toPath)});
const child_process = require('child_process');
const { status } = child_process.spawnSync(esbuild_exe, process.argv.slice(2), { stdio: 'inherit' });
process.exitCode = status === null ? 1 : status;
`);
const absToPath = path.join(__dirname, toPath);
if (process.env.ESBUILD_BIN_PATH_FOR_TESTS) {
fs.copyFileSync(process.env.ESBUILD_BIN_PATH_FOR_TESTS, absToPath);
validateBinaryVersion(process.env.ESBUILD_BIN_PATH_FOR_TESTS);
} else {
installBinaryFromPackage(name, fromPath, absToPath)
.catch(e => setImmediate(() => { throw e; }));
}
}
function installOnUnix(name: string): void {
// Yarn 2 is deliberately incompatible with binary modules because the
// developers of Yarn 2 don't think they should be used. See this thread for
// details: https://github.com/yarnpkg/berry/issues/882.
//
// We want to avoid slowing down esbuild for everyone just because of this
// decision by the Yarn 2 developers, so we explicitly detect if esbuild is
// being installed using Yarn 2 and install a compatability shim only for
// Yarn 2. Normal package managers can just run the binary directly for
// maximum speed.
if (isYarnBerryOrNewer()) {
installWithWrapper(name, "bin/esbuild", "esbuild");
} else {
installDirectly(name);
}
}
function installOnWindows(name: string): void {
installWithWrapper(name, "esbuild.exe", "esbuild.exe");
}
const platformKey = `${process.platform} ${os.arch()} ${os.endianness()}`;
const knownWindowsPackages: Record<string, string> = {
'win32 ia32 LE': 'esbuild-windows-32',
'win32 x64 LE': 'esbuild-windows-64',
};
const knownUnixlikePackages: Record<string, string> = {
'darwin x64 LE': 'esbuild-darwin-64',
'darwin arm64 LE': 'esbuild-darwin-64',
'freebsd arm64 LE': 'esbuild-freebsd-arm64',
'freebsd x64 LE': 'esbuild-freebsd-64',
'linux arm LE': 'esbuild-linux-arm',
'linux arm64 LE': 'esbuild-linux-arm64',
'linux ia32 LE': 'esbuild-linux-32',
'linux mips64el LE': 'esbuild-linux-mips64le',
'linux ppc64 LE': 'esbuild-linux-ppc64le',
'linux x64 LE': 'esbuild-linux-64',
};
// Pick a package to install
if (platformKey in knownWindowsPackages) {
installOnWindows(knownWindowsPackages[platformKey]);
} else if (platformKey in knownUnixlikePackages) {
installOnUnix(knownUnixlikePackages[platformKey]);
} else {
console.error(`Unsupported platform: ${platformKey}`);
process.exit(1);
}