@overwolf/ow-app-builder-lib
Version:
ow-electron-builder lib
214 lines • 9.86 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ELECTRON_COMPILE_SHIM_FILENAME = void 0;
exports.getDestinationPath = getDestinationPath;
exports.copyAppFiles = copyAppFiles;
exports.transformFiles = transformFiles;
exports.computeFileSets = computeFileSets;
exports.computeNodeModuleFileSets = computeNodeModuleFileSets;
const builder_util_1 = require("builder-util");
const fs_extra_1 = require("fs-extra");
const promises_1 = require("fs/promises");
const path = require("path");
const tiny_async_pool_1 = require("tiny-async-pool");
const unpackDetector_1 = require("../asar/unpackDetector");
const core_1 = require("../core");
const fileMatcher_1 = require("../fileMatcher");
const fileTransformer_1 = require("../fileTransformer");
const AppFileWalker_1 = require("./AppFileWalker");
const NodeModuleCopyHelper_1 = require("./NodeModuleCopyHelper");
const node_module_collector_1 = require("../node-module-collector");
const BOWER_COMPONENTS_PATTERN = `${path.sep}bower_components${path.sep}`;
/** @internal */
exports.ELECTRON_COMPILE_SHIM_FILENAME = "__shim.js";
function getDestinationPath(file, fileSet) {
if (file === fileSet.src) {
return fileSet.destination;
}
const src = fileSet.src;
const dest = fileSet.destination;
// get node_modules path relative to src and then append to dest
if (file.startsWith(src)) {
return path.join(dest, path.relative(src, file));
}
return dest;
}
async function copyAppFiles(fileSet, packager, transformer) {
const metadata = fileSet.metadata;
// search auto unpacked dir
const taskManager = new builder_util_1.AsyncTaskManager(packager.cancellationToken);
const createdParentDirs = new Set();
const fileCopier = new builder_util_1.FileCopier(file => {
return !(0, unpackDetector_1.isLibOrExe)(file);
}, transformer);
const links = [];
for (let i = 0, n = fileSet.files.length; i < n; i++) {
const sourceFile = fileSet.files[i];
const stat = metadata.get(sourceFile);
if (stat == null) {
// dir
continue;
}
const destinationFile = getDestinationPath(sourceFile, fileSet);
if (stat.isSymbolicLink()) {
links.push({ file: destinationFile, link: await (0, promises_1.readlink)(sourceFile) });
continue;
}
const fileParent = path.dirname(destinationFile);
if (!createdParentDirs.has(fileParent)) {
createdParentDirs.add(fileParent);
await (0, promises_1.mkdir)(fileParent, { recursive: true });
}
taskManager.addTask(fileCopier.copy(sourceFile, destinationFile, stat));
if (taskManager.tasks.length > builder_util_1.MAX_FILE_REQUESTS) {
await taskManager.awaitTasks();
}
}
if (taskManager.tasks.length > 0) {
await taskManager.awaitTasks();
}
await (0, tiny_async_pool_1.default)(builder_util_1.MAX_FILE_REQUESTS, links, it => (0, fs_extra_1.ensureSymlink)(it.link, it.file));
}
// used only for ASAR, if no asar, file transformed on the fly
async function transformFiles(transformer, fileSet) {
if (transformer == null) {
return;
}
let transformedFiles = fileSet.transformedFiles;
if (fileSet.transformedFiles == null) {
transformedFiles = new Map();
fileSet.transformedFiles = transformedFiles;
}
const metadata = fileSet.metadata;
const filesPromise = fileSet.files.map(async (it, index) => {
const fileStat = metadata.get(it);
if (fileStat == null || !fileStat.isFile()) {
return;
}
const transformedValue = transformer(it);
if (transformedValue == null) {
return;
}
if (typeof transformedValue === "object" && "then" in transformedValue) {
return transformedValue.then(it => {
if (it != null) {
transformedFiles.set(index, it);
}
return;
});
}
transformedFiles.set(index, transformedValue);
return;
});
// `asyncPool` doesn't provide `index` in it's handler, so we `map` first before using it
await (0, tiny_async_pool_1.default)(builder_util_1.MAX_FILE_REQUESTS, filesPromise, promise => promise);
}
async function computeFileSets(matchers, transformer, platformPackager, isElectronCompile) {
const fileSets = [];
const packager = platformPackager.info;
for (const matcher of matchers) {
const fileWalker = new AppFileWalker_1.AppFileWalker(matcher, packager);
const fromStat = await (0, builder_util_1.statOrNull)(matcher.from);
if (fromStat == null) {
builder_util_1.log.debug({ directory: matcher.from, reason: "doesn't exist" }, `skipped copying`);
continue;
}
const files = await (0, builder_util_1.walk)(matcher.from, fileWalker.filter, fileWalker);
const metadata = fileWalker.metadata;
fileSets.push(validateFileSet({ src: matcher.from, files, metadata, destination: matcher.to }));
}
if (isElectronCompile) {
// cache files should be first (better IO)
fileSets.unshift(await compileUsingElectronCompile(fileSets[0], packager));
}
return fileSets;
}
function getNodeModuleExcludedExts(platformPackager) {
// do not exclude *.h files (https://github.com/electron-userland/electron-builder/issues/2852)
const result = [".o", ".obj"].concat(fileMatcher_1.excludedExts.split(",").map(it => `.${it}`));
if (platformPackager.config.includePdb !== true) {
result.push(".pdb");
}
if (platformPackager.platform !== core_1.Platform.WINDOWS) {
// https://github.com/electron-userland/electron-builder/issues/1738
result.push(".dll");
result.push(".exe");
}
return result;
}
function validateFileSet(fileSet) {
if (fileSet.src == null || fileSet.src.length === 0) {
throw new Error("fileset src is empty");
}
return fileSet;
}
/** @internal */
async function computeNodeModuleFileSets(platformPackager, mainMatcher) {
const deps = await (0, node_module_collector_1.getNodeModules)(platformPackager.info.appDir);
builder_util_1.log.debug({ nodeModules: deps }, "collected node modules");
const nodeModuleExcludedExts = getNodeModuleExcludedExts(platformPackager);
// serial execution because copyNodeModules is concurrent and so, no need to increase queue/pressure
const result = new Array();
let index = 0;
const NODE_MODULES = "node_modules";
const collectNodeModules = async (dep, destination) => {
const source = dep.dir;
const matcher = new fileMatcher_1.FileMatcher(source, destination, mainMatcher.macroExpander, mainMatcher.patterns);
const copier = new NodeModuleCopyHelper_1.NodeModuleCopyHelper(matcher, platformPackager.info);
const files = await copier.collectNodeModules(dep, nodeModuleExcludedExts, path.relative(mainMatcher.to, destination));
result[index++] = validateFileSet({ src: source, destination, files, metadata: copier.metadata });
if (dep.dependencies) {
for (const c of dep.dependencies) {
await collectNodeModules(c, path.join(destination, NODE_MODULES, c.name));
}
}
};
for (const dep of deps) {
const destination = path.join(mainMatcher.to, NODE_MODULES, dep.name);
await collectNodeModules(dep, destination);
}
return result;
}
async function compileUsingElectronCompile(mainFileSet, packager) {
builder_util_1.log.info("compiling using electron-compile");
const electronCompileCache = await packager.tempDirManager.getTempDir({ prefix: "electron-compile-cache" });
const cacheDir = path.join(electronCompileCache, ".cache");
// clear and create cache dir
await (0, promises_1.mkdir)(cacheDir, { recursive: true });
const compilerHost = await (0, fileTransformer_1.createElectronCompilerHost)(mainFileSet.src, cacheDir);
const nextSlashIndex = mainFileSet.src.length + 1;
// pre-compute electron-compile to cache dir - we need to process only subdirectories, not direct files of app dir
const filesPromise = mainFileSet.files.map(file => {
if (file.includes(fileTransformer_1.NODE_MODULES_PATTERN) ||
file.includes(BOWER_COMPONENTS_PATTERN) ||
!file.includes(path.sep, nextSlashIndex) || // ignore not root files
!mainFileSet.metadata.get(file).isFile()) {
return;
}
return compilerHost.compile(file);
});
await (0, tiny_async_pool_1.default)(builder_util_1.MAX_FILE_REQUESTS, filesPromise, promise => promise);
await compilerHost.saveConfiguration();
const metadata = new Map();
const cacheFiles = await (0, builder_util_1.walk)(cacheDir, file => !file.startsWith("."), {
consume: (file, fileStat) => {
if (fileStat.isFile()) {
metadata.set(file, fileStat);
}
return null;
},
});
// add shim
const shimPath = `${mainFileSet.src}${path.sep}${exports.ELECTRON_COMPILE_SHIM_FILENAME}`;
mainFileSet.files.push(shimPath);
mainFileSet.metadata.set(shimPath, { isFile: () => true, isDirectory: () => false, isSymbolicLink: () => false });
if (mainFileSet.transformedFiles == null) {
mainFileSet.transformedFiles = new Map();
}
mainFileSet.transformedFiles.set(mainFileSet.files.length - 1, `
'use strict';
require('electron-compile').init(__dirname, require('path').resolve(__dirname, '${packager.metadata.main || "index"}'), true);
`);
return { src: electronCompileCache, files: cacheFiles, metadata, destination: mainFileSet.destination };
}
//# sourceMappingURL=appFileCopier.js.map