1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-30 08:09:15 +01:00
metamask-extension/development/build/task.js
Mark Stacey e8b7fcf8dc
Fix LavaMoat background policy generation (#12844)
The LavaMoat policy generation script would sporadically fail because
it ran the build concurrently three times, and the build includes
steps that delete the `dist` directory and write to it. So if one build
process tried to write to the directory after another deleted it, it
would fail.

This was solved by adding a new `--policy-only` flag to the build
script, and a new `scripts:prod` task. The `scripts:prod` task only
runs the script tasks for prod, rather than the entire build process.
The `--policy-only` flag stops the script tasks once the policy has
been written, and stops any other files from being written to disk.

This prevents the three concurrent build processes from getting in each
others way, and it dramatically speeds up the process.
2021-11-26 16:38:23 -03:30

156 lines
3.7 KiB
JavaScript

const EventEmitter = require('events');
const spawn = require('cross-spawn');
const tasks = {};
const taskEvents = new EventEmitter();
module.exports = {
tasks,
taskEvents,
createTask,
runTask,
composeSeries,
composeParallel,
runInChildProcess,
};
const { setupTaskDisplay } = require('./display');
async function runTask(taskName, { skipStats } = {}) {
if (!(taskName in tasks)) {
throw new Error(`MetaMask build: Unrecognized task name "${taskName}"`);
}
if (!skipStats) {
setupTaskDisplay(taskEvents);
console.log(`Running task "${taskName}"...`);
}
try {
await tasks[taskName]();
} catch (err) {
console.error(
`MetaMask build: Encountered an error while running task "${taskName}".`,
);
console.error(err);
process.exit(1);
}
taskEvents.emit('complete');
}
function createTask(taskName, taskFn) {
if (taskName in tasks) {
throw new Error(
`MetaMask build: task "${taskName}" already exists. Refusing to redefine`,
);
}
const task = instrumentForTaskStats(taskName, taskFn);
task.taskName = taskName;
tasks[taskName] = task;
return task;
}
function runInChildProcess(
task,
{ buildType, isLavaMoat, policyOnly, shouldLintFenceFiles },
) {
const taskName = typeof task === 'string' ? task : task.taskName;
if (!taskName) {
throw new Error(
`MetaMask build: runInChildProcess unable to identify task name`,
);
}
return instrumentForTaskStats(taskName, async () => {
let childProcess;
// Use the same build type for subprocesses, and only run them in LavaMoat
// if the parent process also ran in LavaMoat.
if (isLavaMoat) {
childProcess = spawn(
'yarn',
[
'build',
taskName,
'--build-type',
buildType,
'--lint-fence-files',
shouldLintFenceFiles,
'--skip-stats',
...(policyOnly ? ['--policy-only'] : []),
],
{
env: process.env,
},
);
} else {
childProcess = spawn(
'yarn',
[
'build:dev',
taskName,
'--build-type',
buildType,
'--lint-fence-files',
shouldLintFenceFiles,
'--skip-stats',
...(policyOnly ? ['--policy-only'] : []),
],
{
env: process.env,
},
);
}
// forward logs to main process
// skip the first stdout event (announcing the process command)
childProcess.stdout.once('data', () => {
childProcess.stdout.on('data', (data) =>
process.stdout.write(`${taskName}: ${data}`),
);
});
childProcess.stderr.on('data', (data) =>
process.stderr.write(`${taskName}: ${data}`),
);
// await end of process
await new Promise((resolve, reject) => {
childProcess.once('exit', (errCode) => {
if (errCode !== 0) {
reject(
new Error(
`MetaMask build: runInChildProcess for task "${taskName}" encountered an error "${errCode}".`,
),
);
return;
}
resolve();
});
});
});
}
function instrumentForTaskStats(taskName, asyncFn) {
return async () => {
const start = Date.now();
taskEvents.emit('start', [taskName, start]);
await asyncFn();
const end = Date.now();
taskEvents.emit('end', [taskName, start, end]);
};
}
function composeSeries(...subtasks) {
return async () => {
const realTasks = subtasks;
for (const subtask of realTasks) {
await subtask();
}
};
}
function composeParallel(...subtasks) {
return async () => {
const realTasks = subtasks;
await Promise.all(realTasks.map((subtask) => subtask()));
};
}