1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 09:52:26 +01:00
metamask-extension/development/build/task.js
Mark Stacey e3420a4262
Fix build script errors (#15493)
There is a SES bug that results in errors being printed to the console
as `{}`[1]. The known workaround is to print the error stack rather
than printing the error directly. This affects our build script when it
is run with LavaMoat.

We used this workaround in one place in the build script already, but
not in the handler for task errors. We now use it in both places.

The workaround has been moved to a function that we can use throughout
the build script.

[1]: https://github.com/endojs/endo/issues/944
2022-08-06 03:33:35 -04:00

136 lines
3.4 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');
const { logError } = require('./utils');
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}".`,
);
logError(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,
{ applyLavaMoat, 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 () => {
const childProcess = spawn(
'yarn',
[
// Use the same build type for subprocesses, and only run them in
// LavaMoat if the parent process also ran in LavaMoat.
isLavaMoat ? 'build' : 'build:dev',
taskName,
`--apply-lavamoat=${applyLavaMoat ? 'true' : 'false'}`,
`--build-type=${buildType}`,
`--lint-fence-files=${shouldLintFenceFiles ? 'true' : 'false'}`,
`--policyOnly=${policyOnly ? 'true' : 'false'}`,
'--skip-stats=true',
],
{
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()));
};
}