|
|
|
const { promises: fs } = require('fs');
|
|
|
|
const path = require('path');
|
|
|
|
const { merge, cloneDeep } = require('lodash');
|
|
|
|
|
|
|
|
const baseManifest = require('../../app/manifest/_base.json');
|
|
|
|
const { version } = require('../../package.json');
|
|
|
|
const betaManifestModifications = require('../../app/manifest/_beta_modifications.json');
|
|
|
|
|
|
|
|
const { createTask, composeSeries } = require('./task');
|
|
|
|
|
|
|
|
module.exports = createManifestTasks;
|
|
|
|
|
Rationalize build system arguments (#12047)
This rationalizes how arguments are passed to and parsed by the build system. To accomplish this, everything that isn't an environment variable from `.metamaskrc` or our CI environment is now passed as an argument on the command line.
Of such arguments, the `entryTask` is still expected as a positional argument in the first position (i.e. `process.argv[2]`), but everything else must be passed as a named argument. We use `minimist` to parse the arguments, and set defaults to preserve existing behavior.
Arguments are parsed in a new function, `parseArgv`, in `development/build/index.js`. They are assigned to environment variables where convenient, and otherwise returned from `parseArgv` to be passed to other functions invoked in the same file.
This change is motivated by our previous inconsistent handling of arguments to the build system, which will grow increasingly problematic as the build system grows in complexity. (Which it will very shortly, as we introduce Flask builds.)
Miscellaneous changes:
- Adds a build system readme at `development/build/README.md`
- Removes the `beta` package script. Now, we can instead call: `yarn dist --build-type beta`
- Fixes the casing of some log messages and reorders some parameters in the build system
3 years ago
|
|
|
function createManifestTasks({ betaVersionsMap, browserPlatforms, isBeta }) {
|
|
|
|
// merge base manifest with per-platform manifests
|
|
|
|
const prepPlatforms = async () => {
|
|
|
|
return Promise.all(
|
|
|
|
browserPlatforms.map(async (platform) => {
|
|
|
|
const platformModifications = await readJson(
|
|
|
|
path.join(
|
|
|
|
__dirname,
|
|
|
|
'..',
|
|
|
|
'..',
|
|
|
|
'app',
|
|
|
|
'manifest',
|
|
|
|
`${platform}.json`,
|
|
|
|
),
|
|
|
|
);
|
|
|
|
const result = merge(
|
|
|
|
cloneDeep(baseManifest),
|
|
|
|
platformModifications,
|
|
|
|
isBeta
|
|
|
|
? getBetaModifications(platform, betaVersionsMap)
|
|
|
|
: { version },
|
|
|
|
);
|
|
|
|
const dir = path.join('.', 'dist', platform);
|
|
|
|
await fs.mkdir(dir, { recursive: true });
|
|
|
|
await writeJson(result, path.join(dir, 'manifest.json'));
|
|
|
|
}),
|
|
|
|
);
|
|
|
|
};
|
|
|
|
|
|
|
|
// dev: add perms
|
|
|
|
const envDev = createTaskForModifyManifestForEnvironment((manifest) => {
|
|
|
|
manifest.permissions = [...manifest.permissions, 'webRequestBlocking'];
|
|
|
|
});
|
|
|
|
|
|
|
|
// testDev: add perms
|
|
|
|
const envTestDev = createTaskForModifyManifestForEnvironment((manifest) => {
|
|
|
|
manifest.permissions = [
|
|
|
|
...manifest.permissions,
|
|
|
|
'webRequestBlocking',
|
|
|
|
'http://localhost/*',
|
|
|
|
];
|
|
|
|
});
|
|
|
|
|
|
|
|
// test: add permissions
|
|
|
|
const envTest = createTaskForModifyManifestForEnvironment((manifest) => {
|
|
|
|
manifest.permissions = [
|
|
|
|
...manifest.permissions,
|
|
|
|
'webRequestBlocking',
|
|
|
|
'http://localhost/*',
|
|
|
|
];
|
|
|
|
});
|
|
|
|
|
|
|
|
// high level manifest tasks
|
|
|
|
const dev = createTask('manifest:dev', composeSeries(prepPlatforms, envDev));
|
|
|
|
|
|
|
|
const testDev = createTask(
|
|
|
|
'manifest:testDev',
|
|
|
|
composeSeries(prepPlatforms, envTestDev),
|
|
|
|
);
|
|
|
|
|
|
|
|
const test = createTask(
|
|
|
|
'manifest:test',
|
|
|
|
composeSeries(prepPlatforms, envTest),
|
|
|
|
);
|
|
|
|
|
|
|
|
const prod = createTask('manifest:prod', prepPlatforms);
|
|
|
|
|
|
|
|
return { prod, dev, testDev, test };
|
|
|
|
|
|
|
|
// helper for modifying each platform's manifest.json in place
|
|
|
|
function createTaskForModifyManifestForEnvironment(transformFn) {
|
|
|
|
return () => {
|
|
|
|
return Promise.all(
|
|
|
|
browserPlatforms.map(async (platform) => {
|
|
|
|
const manifestPath = path.join(
|
|
|
|
'.',
|
|
|
|
'dist',
|
|
|
|
platform,
|
|
|
|
'manifest.json',
|
|
|
|
);
|
|
|
|
const manifest = await readJson(manifestPath);
|
|
|
|
transformFn(manifest);
|
|
|
|
await writeJson(manifest, manifestPath);
|
|
|
|
}),
|
|
|
|
);
|
|
|
|
};
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// helper for reading and deserializing json from fs
|
|
|
|
async function readJson(file) {
|
|
|
|
return JSON.parse(await fs.readFile(file, 'utf8'));
|
|
|
|
}
|
|
|
|
|
|
|
|
// helper for serializing and writing json to fs
|
|
|
|
async function writeJson(obj, file) {
|
|
|
|
return fs.writeFile(file, JSON.stringify(obj, null, 2));
|
|
|
|
}
|
|
|
|
|
|
|
|
function getBetaModifications(platform, betaVersionsMap) {
|
Rationalize build system arguments (#12047)
This rationalizes how arguments are passed to and parsed by the build system. To accomplish this, everything that isn't an environment variable from `.metamaskrc` or our CI environment is now passed as an argument on the command line.
Of such arguments, the `entryTask` is still expected as a positional argument in the first position (i.e. `process.argv[2]`), but everything else must be passed as a named argument. We use `minimist` to parse the arguments, and set defaults to preserve existing behavior.
Arguments are parsed in a new function, `parseArgv`, in `development/build/index.js`. They are assigned to environment variables where convenient, and otherwise returned from `parseArgv` to be passed to other functions invoked in the same file.
This change is motivated by our previous inconsistent handling of arguments to the build system, which will grow increasingly problematic as the build system grows in complexity. (Which it will very shortly, as we introduce Flask builds.)
Miscellaneous changes:
- Adds a build system readme at `development/build/README.md`
- Removes the `beta` package script. Now, we can instead call: `yarn dist --build-type beta`
- Fixes the casing of some log messages and reorders some parameters in the build system
3 years ago
|
|
|
if (!betaVersionsMap || typeof betaVersionsMap !== 'object') {
|
|
|
|
throw new Error('MetaMask build: Expected object beta versions map.');
|
|
|
|
}
|
|
|
|
|
|
|
|
const betaVersion = betaVersionsMap[platform];
|
|
|
|
|
|
|
|
return {
|
|
|
|
...betaManifestModifications,
|
|
|
|
version: betaVersion,
|
|
|
|
...(platform === 'firefox' ? {} : { version_name: 'beta' }),
|
|
|
|
};
|
|
|
|
}
|