rebuild.ts
19.9 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
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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
import { spawnPromise } from 'spawn-rx';
import * as crypto from 'crypto';
import * as debug from 'debug';
import * as detectLibc from 'detect-libc';
import { EventEmitter } from 'events';
import * as fs from 'fs-extra';
import * as nodeAbi from 'node-abi';
import * as os from 'os';
import * as path from 'path';
import { readPackageJson } from './read-package-json';
import { lookupModuleState, cacheModuleState } from './cache';
import { searchForModule, searchForNodeModules } from './search-module';
export type ModuleType = 'prod' | 'dev' | 'optional';
export type RebuildMode = 'sequential' | 'parallel';
export interface RebuildOptions {
buildPath: string;
electronVersion: string;
arch?: string;
extraModules?: string[];
onlyModules?: string[] | null;
force?: boolean;
headerURL?: string;
types?: ModuleType[];
mode?: RebuildMode;
debug?: boolean;
useCache?: boolean;
cachePath?: string;
prebuildTagPrefix?: string;
projectRootPath?: string;
forceABI?: number;
}
export type HashTree = { [path: string]: string | HashTree };
export interface RebuilderOptions extends RebuildOptions {
lifecycle: EventEmitter;
}
const d = debug('electron-rebuild');
const defaultMode: RebuildMode = process.platform === 'win32' ? 'sequential' : 'parallel';
const defaultTypes: ModuleType[] = ['prod', 'optional'];
// Update this number if you change the caching logic to ensure no bad cache hits
const ELECTRON_REBUILD_CACHE_ID = 1;
const locateBinary = async (basePath: string, suffix: string): Promise<string | null> => {
let testPath = basePath;
for (let upDir = 0; upDir <= 20; upDir ++) {
const checkPath = path.resolve(testPath, suffix);
if (await fs.pathExists(checkPath)) {
return checkPath;
}
testPath = path.resolve(testPath, '..');
}
return null;
};
const locateNodeGyp = async (): Promise<string | null> => {
return await locateBinary(__dirname, `node_modules/.bin/node-gyp${process.platform === 'win32' ? '.cmd' : ''}`);
};
const locatePrebuild = async (modulePath: string): Promise<string | null> => {
return await locateBinary(modulePath, 'node_modules/prebuild-install/bin.js');
};
class Rebuilder {
ABI: string;
nodeGypPath: string;
prodDeps: Set<string>;
rebuilds: (() => Promise<void>)[];
realModulePaths: Set<string>;
realNodeModulesPaths: Set<string>;
public lifecycle: EventEmitter;
public buildPath: string;
public electronVersion: string;
public arch: string;
public extraModules: string[];
public onlyModules: string[] | null;
public force: boolean;
public headerURL: string;
public types: ModuleType[];
public mode: RebuildMode;
public debug: boolean;
public useCache: boolean;
public cachePath: string;
public prebuildTagPrefix: string;
public projectRootPath?: string;
constructor(options: RebuilderOptions) {
this.lifecycle = options.lifecycle;
this.buildPath = options.buildPath;
this.electronVersion = options.electronVersion;
this.arch = options.arch || process.arch;
this.extraModules = options.extraModules || [];
this.onlyModules = options.onlyModules || null;
this.force = options.force || false;
this.headerURL = options.headerURL || 'https://www.electronjs.org/headers';
this.types = options.types || defaultTypes;
this.mode = options.mode || defaultMode;
this.debug = options.debug || false;
this.useCache = options.useCache || false;
this.cachePath = options.cachePath || path.resolve(os.homedir(), '.electron-rebuild-cache');
this.prebuildTagPrefix = options.prebuildTagPrefix || 'v';
if (this.useCache && this.force) {
console.warn('[WARNING]: Electron Rebuild has force enabled and cache enabled, force take precedence and the cache will not be used.');
this.useCache = false;
}
this.projectRootPath = options.projectRootPath;
if (typeof this.electronVersion === 'number') {
if (`${this.electronVersion}`.split('.').length === 1) {
this.electronVersion = `${this.electronVersion}.0.0`;
} else {
this.electronVersion = `${this.electronVersion}.0`;
}
}
if (typeof this.electronVersion !== 'string') {
throw new Error(`Expected a string version for electron version, got a "${typeof this.electronVersion}"`);
}
this.ABI = options.forceABI || nodeAbi.getAbi(this.electronVersion, 'electron');
this.prodDeps = this.extraModules.reduce((acc: Set<string>, x: string) => acc.add(x), new Set<string>());
this.rebuilds = [];
this.realModulePaths = new Set();
this.realNodeModulesPaths = new Set();
}
async rebuild(): Promise<void> {
if (!path.isAbsolute(this.buildPath)) {
throw new Error('Expected buildPath to be an absolute path');
}
d(
'rebuilding with args:',
this.buildPath,
this.electronVersion,
this.arch,
this.extraModules,
this.force,
this.headerURL,
this.types,
this.debug
);
this.lifecycle.emit('start');
const rootPackageJson = await readPackageJson(this.buildPath);
const markWaiters: Promise<void>[] = [];
const depKeys = [];
if (this.types.indexOf('prod') !== -1 || this.onlyModules) {
depKeys.push(...Object.keys(rootPackageJson.dependencies || {}));
}
if (this.types.indexOf('optional') !== -1 || this.onlyModules) {
depKeys.push(...Object.keys(rootPackageJson.optionalDependencies || {}));
}
if (this.types.indexOf('dev') !== -1 || this.onlyModules) {
depKeys.push(...Object.keys(rootPackageJson.devDependencies || {}));
}
for (const key of depKeys) {
this.prodDeps[key] = true;
const modulePaths: string[] = await searchForModule(
this.buildPath,
key,
this.projectRootPath
);
for (const modulePath of modulePaths) {
markWaiters.push(this.markChildrenAsProdDeps(modulePath));
}
}
await Promise.all(markWaiters);
d('identified prod deps:', this.prodDeps);
const nodeModulesPaths = await searchForNodeModules(
this.buildPath,
this.projectRootPath
);
for (const nodeModulesPath of nodeModulesPaths) {
await this.rebuildAllModulesIn(nodeModulesPath);
}
this.rebuilds.push(() => this.rebuildModuleAt(this.buildPath));
if (this.mode !== 'sequential') {
await Promise.all(this.rebuilds.map(fn => fn()));
} else {
for (const rebuildFn of this.rebuilds) {
await rebuildFn();
}
}
}
private hashDirectory = async (dir: string, relativeTo = dir): Promise<HashTree> => {
d('hashing dir', dir);
const dirTree: HashTree = {};
await Promise.all((await fs.readdir(dir)).map(async (child) => {
d('found child', child, 'in dir', dir);
// Ignore output directories
if (dir === relativeTo && (child === 'build' || child === 'bin')) return;
// Don't hash nested node_modules
if (child === 'node_modules') return;
const childPath = path.resolve(dir, child);
const relative = path.relative(relativeTo, childPath);
if ((await fs.stat(childPath)).isDirectory()) {
dirTree[relative] = await this.hashDirectory(childPath, relativeTo);
} else {
dirTree[relative] = crypto.createHash('SHA256').update(await fs.readFile(childPath)).digest('hex');
}
}));
return dirTree;
}
private dHashTree = (tree: HashTree, hash: crypto.Hash): void => {
for (const key of Object.keys(tree).sort()) {
hash.update(key);
if (typeof tree[key] === 'string') {
hash.update(tree[key] as string);
} else {
this.dHashTree(tree[key] as HashTree, hash);
}
}
}
private generateCacheKey = async (opts: { modulePath: string }): Promise<string> => {
const tree = await this.hashDirectory(opts.modulePath);
const hasher = crypto.createHash('SHA256')
.update(`${ELECTRON_REBUILD_CACHE_ID}`)
.update(path.basename(opts.modulePath))
.update(this.ABI)
.update(this.arch)
.update(this.debug ? 'debug' : 'not debug')
.update(this.headerURL)
.update(this.electronVersion);
this.dHashTree(tree, hasher);
const hash = hasher.digest('hex');
d('calculated hash of', opts.modulePath, 'to be', hash);
return hash;
}
async rebuildModuleAt(modulePath: string): Promise<void> {
if (!(await fs.pathExists(path.resolve(modulePath, 'binding.gyp')))) {
return;
}
const nodeGypPath = await locateNodeGyp();
if (!nodeGypPath) {
throw new Error('Could not locate node-gyp');
}
const buildType = this.debug ? 'Debug' : 'Release';
const metaPath = path.resolve(modulePath, 'build', buildType, '.forge-meta');
const metaData = `${this.arch}--${this.ABI}`;
this.lifecycle.emit('module-found', path.basename(modulePath));
if (!this.force && await fs.pathExists(metaPath)) {
const meta = await fs.readFile(metaPath, 'utf8');
if (meta === metaData) {
d(`skipping: ${path.basename(modulePath)} as it is already built`);
this.lifecycle.emit('module-done');
this.lifecycle.emit('module-skip');
return;
}
}
// prebuild already exists
if (await fs.pathExists(path.resolve(modulePath, 'prebuilds', `${process.platform}-${this.arch}`, `electron-${this.ABI}.node`))) {
d(`skipping: ${path.basename(modulePath)} as it was prebuilt`);
return;
}
let cacheKey!: string;
if (this.useCache) {
cacheKey = await this.generateCacheKey({
modulePath,
});
const applyDiffFn = await lookupModuleState(this.cachePath, cacheKey);
if (typeof applyDiffFn === 'function') {
await applyDiffFn(modulePath);
this.lifecycle.emit('module-done');
return;
}
}
const modulePackageJson = await readPackageJson(modulePath);
if ((modulePackageJson.dependencies || {})['prebuild-install']) {
d(`assuming is prebuild powered: ${path.basename(modulePath)}`);
const prebuildInstallPath = await locatePrebuild(modulePath);
if (prebuildInstallPath) {
d(`triggering prebuild download step: ${path.basename(modulePath)}`);
let success = false;
const shimExt = process.env.ELECTRON_REBUILD_TESTS ? 'ts' : 'js';
const executable = process.env.ELECTRON_REBUILD_TESTS ? path.resolve(__dirname, '..', 'node_modules', '.bin', 'ts-node') : process.execPath;
try {
await spawnPromise(
executable,
[
path.resolve(__dirname, `prebuild-shim.${shimExt}`),
prebuildInstallPath,
`--arch=${this.arch}`,
`--platform=${process.platform}`,
'--runtime=electron',
`--target=${this.electronVersion}`,
`--tag-prefix=${this.prebuildTagPrefix}`
],
{
cwd: modulePath,
}
);
success = true;
} catch (err) {
d('failed to use prebuild-install:', err);
}
if (success) {
d('built:', path.basename(modulePath));
await fs.mkdirs(path.dirname(metaPath));
await fs.writeFile(metaPath, metaData);
if (this.useCache) {
await cacheModuleState(modulePath, this.cachePath, cacheKey);
}
this.lifecycle.emit('module-done');
return;
}
} else {
d(`could not find prebuild-install relative to: ${modulePath}`);
}
}
if (modulePath.indexOf(' ') !== -1) {
console.error('Attempting to build a module with a space in the path');
console.error('See https://github.com/nodejs/node-gyp/issues/65#issuecomment-368820565 for reasons why this may not work');
// FIXME: Re-enable the throw when more research has been done
// throw new Error(`node-gyp does not support building modules with spaces in their path, tried to build: ${modulePath}`);
}
d('rebuilding:', path.basename(modulePath));
const rebuildArgs = [
'rebuild',
`--target=${this.electronVersion}`,
`--arch=${this.arch}`,
`--dist-url=${this.headerURL}`,
'--build-from-source',
];
if (this.debug) {
rebuildArgs.push('--debug');
}
for (const binaryKey of Object.keys(modulePackageJson.binary || {})) {
if (binaryKey === 'napi_versions') {
continue;
}
let value = modulePackageJson.binary[binaryKey];
if (binaryKey === 'module_path') {
value = path.resolve(modulePath, value);
}
value = value.replace('{configuration}', buildType)
.replace('{node_abi}', `electron-v${this.electronVersion.split('.').slice(0, 2).join('.')}`)
.replace('{platform}', process.platform)
.replace('{arch}', this.arch)
.replace('{version}', modulePackageJson.version)
.replace('{libc}', detectLibc.family || 'unknown');
for (const binaryReplaceKey of Object.keys(modulePackageJson.binary)) {
value = value.replace(`{${binaryReplaceKey}}`, modulePackageJson.binary[binaryReplaceKey]);
}
rebuildArgs.push(`--${binaryKey}=${value}`);
}
if (process.env.GYP_MSVS_VERSION) {
rebuildArgs.push(`--msvs_version=${process.env.GYP_MSVS_VERSION}`);
}
d('rebuilding', path.basename(modulePath), 'with args', rebuildArgs);
await spawnPromise(nodeGypPath, rebuildArgs, {
cwd: modulePath,
/* eslint-disable @typescript-eslint/camelcase */
env: Object.assign({}, process.env, {
USERPROFILE: path.resolve(os.homedir(), '.electron-gyp'),
npm_config_disturl: 'https://www.electronjs.org/headers',
npm_config_runtime: 'electron',
npm_config_arch: this.arch,
npm_config_target_arch: this.arch,
npm_config_build_from_source: 'true',
npm_config_debug: this.debug ? 'true' : '',
npm_config_devdir: path.resolve(os.homedir(), '.electron-gyp'),
}),
/* eslint-enable @typescript-eslint/camelcase */
});
d('built:', path.basename(modulePath));
await fs.mkdirs(path.dirname(metaPath));
await fs.writeFile(metaPath, metaData);
const moduleName = path.basename(modulePath);
const buildLocation = 'build/' + buildType;
d('searching for .node file', path.resolve(modulePath, buildLocation));
d('testing files', (await fs.readdir(path.resolve(modulePath, buildLocation))));
const nodeFile = (await fs.readdir(path.resolve(modulePath, buildLocation)))
.find((file) => file !== '.node' && file.endsWith('.node'));
const nodePath = nodeFile ? path.resolve(modulePath, buildLocation, nodeFile) : undefined;
const abiPath = path.resolve(modulePath, `bin/${process.platform}-${this.arch}-${this.ABI}`);
if (nodePath && await fs.pathExists(nodePath)) {
d('found .node file', nodePath);
d('copying to prebuilt place:', abiPath);
await fs.mkdirs(abiPath);
await fs.copy(nodePath, path.resolve(abiPath, `${moduleName}.node`));
}
if (this.useCache) {
await cacheModuleState(modulePath, this.cachePath, cacheKey);
}
this.lifecycle.emit('module-done');
}
async rebuildAllModulesIn(nodeModulesPath: string, prefix = ''): Promise<void> {
// Some package managers use symbolic links when installing node modules
// we need to be sure we've never tested the a package before by resolving
// all symlinks in the path and testing against a set
const realNodeModulesPath = await fs.realpath(nodeModulesPath);
if (this.realNodeModulesPaths.has(realNodeModulesPath)) {
return;
}
this.realNodeModulesPaths.add(realNodeModulesPath);
d('scanning:', realNodeModulesPath);
for (const modulePath of await fs.readdir(realNodeModulesPath)) {
// Ignore the magical .bin directory
if (modulePath === '.bin') continue;
// Ensure that we don't mark modules as needing to be rebuilt more than once
// by ignoring / resolving symlinks
const realPath = await fs.realpath(path.resolve(nodeModulesPath, modulePath));
if (this.realModulePaths.has(realPath)) {
continue;
}
this.realModulePaths.add(realPath);
if (this.prodDeps[`${prefix}${modulePath}`] && (!this.onlyModules || this.onlyModules.includes(modulePath))) {
this.rebuilds.push(() => this.rebuildModuleAt(realPath));
}
if (modulePath.startsWith('@')) {
await this.rebuildAllModulesIn(realPath, `${modulePath}/`);
}
if (await fs.pathExists(path.resolve(nodeModulesPath, modulePath, 'node_modules'))) {
await this.rebuildAllModulesIn(path.resolve(realPath, 'node_modules'));
}
}
}
async findModule(moduleName: string, fromDir: string, foundFn: ((p: string) => Promise<void>)): Promise<void[]> {
const testPaths = await searchForModule(
fromDir,
moduleName,
this.projectRootPath
);
const foundFns = testPaths.map(testPath => foundFn(testPath));
return Promise.all(foundFns);
}
async markChildrenAsProdDeps(modulePath: string): Promise<void> {
if (!await fs.pathExists(modulePath)) {
return;
}
d('exploring', modulePath);
let childPackageJson;
try {
childPackageJson = await readPackageJson(modulePath, true);
} catch (err) {
return;
}
const moduleWait: Promise<void[]>[] = [];
const callback = this.markChildrenAsProdDeps.bind(this);
for (const key of Object.keys(childPackageJson.dependencies || {}).concat(Object.keys(childPackageJson.optionalDependencies || {}))) {
if (this.prodDeps[key]) {
continue;
}
this.prodDeps[key] = true;
moduleWait.push(this.findModule(key, modulePath, callback));
}
await Promise.all(moduleWait);
}
}
function rebuildWithOptions(options: RebuildOptions): Promise<void> {
// eslint-disable-next-line prefer-rest-params
d('rebuilding with args:', arguments);
const lifecycle = new EventEmitter();
const rebuilderOptions: RebuilderOptions = Object.assign({}, options, { lifecycle });
const rebuilder = new Rebuilder(rebuilderOptions);
const ret = rebuilder.rebuild() as Promise<void> & { lifecycle: EventEmitter };
ret.lifecycle = lifecycle;
return ret;
}
export type RebuilderResult = Promise<void> & { lifecycle: EventEmitter };
export type RebuildFunctionWithOptions = (options: RebuildOptions) => RebuilderResult;
export type RebuildFunctionWithArgs = (
buildPath: string,
electronVersion: string,
arch?: string,
extraModules?: string[],
force?: boolean,
headerURL?: string,
types?: ModuleType[],
mode?: RebuildMode,
onlyModules?: string[] | null,
debug?: boolean
) => RebuilderResult;
export type RebuildFunction = RebuildFunctionWithArgs & RebuildFunctionWithOptions;
export function createOptions(
buildPath: string,
electronVersion: string,
arch: string,
extraModules: string[],
force: boolean,
headerURL: string,
types: ModuleType[],
mode: RebuildMode,
onlyModules: string[] | null,
debug: boolean ): RebuildOptions {
return {
buildPath,
electronVersion,
arch,
extraModules,
onlyModules,
force,
headerURL,
types,
mode,
debug
};
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
function doRebuild(options: any, ...args: any[]): Promise<void> {
if (typeof options === 'object') {
return rebuildWithOptions(options as RebuildOptions);
}
console.warn('You are using the deprecated electron-rebuild API, please switch to using the options object instead');
return rebuildWithOptions((createOptions as Function)(options, ...args));
}
export const rebuild = (doRebuild as RebuildFunction);
export function rebuildNativeModules(
electronVersion: string,
modulePath: string,
whichModule= '',
_headersDir: string | null = null,
arch= process.arch,
_command: string,
_ignoreDevDeps= false,
_ignoreOptDeps= false,
_verbose= false): Promise<void> {
if (path.basename(modulePath) === 'node_modules') {
modulePath = path.dirname(modulePath);
}
d('rebuilding in:', modulePath);
console.warn('You are using the old API, please read the new docs and update to the new API');
return rebuild(modulePath, electronVersion, arch, whichModule.split(','));
}