m/metamask-extension
1
0
Fork 0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-26 12:29:06 +01:00
Code
f8a7a83e05
metamask-extension/development/build/constants.js

79 lines
2.9 KiB
JavaScript
Raw Normal View History

Add validation to production build script (#15468) Validation has been added to the build script when the "prod" target is selected. We now ensure that all expected environment variables are set, and that no extra environment variables are present (which might indicate that the wrong configuration file is being used). The `prod` target uses a new `.metamaskprodrc` configuration file. Each required variable can be specified either via environment variable or via this config file. CI will continue set these via environment variable, but for local manual builds we can use the config file to simplify the build process and ensure consistency. A new "dist" target has been added to preserve the ability to build a "production-like" build without this validation. The config validation is invoked early in the script, in the CLI argument parsing step, so that it would fail more quickly. Otherwise we'd have to wait a few minutes longer for the validation to run. This required some refactoring, moving functions to the utility module and moving the config to a dedicated module. Additionally, support has been added for all environment variables to be set via the config file. Previously the values `PUBNUB_PUB_KEY`, `PUBNUB_SUB_KEY`, `SENTRY_DSN`, and `SWAPS_USE_DEV_APIS` could only be set via environment variable. Now, all of these variables can be set either way. Closes #15003
2022-08-19 20:16:18 +02:00
/**
* The build target. This descrbes the overall purpose of the build.
*
* These constants also act as the high-level tasks for the build system (i.e.
* the usual tasks invoked directly via the CLI rather than internally).
*/
Refactor build script to include build target (#15447) The "scripts" portion of the build script has been refactored to pass the "build target" throughout the file. The "build target" is the target environment for the build, reflected by the command used to start the build (e.g. "dev", "prod", "test", or "testDev"). Beforehand we derived the variables `devMode` and `testing` from this build target, and passed these throughout the script. However, there is a future change [1] that requires adding a new build target that acts like "prod" in some ways but not others. It was easier to refactor to pass through `buildTarget` directly than it was to add a _third_ boolean flag to indirectly represent the target. The existence of the "testDev" target made it convenient to still have the `testing` and `devMode` flag, so helper functions were added to derive those values from the build target. I anticipate that these will only be needed temporarily though. We will probably be able to get rid of the `testDev` target and the related complexities when we start adding more flags (like `--watch`[2] and `--minify`[3]) to the build script directly. [1]: https://github.com/MetaMask/metamask-extension/issues/15003 [2]: https://github.com/MetaMask/metamask-extension/issues/12767 [3]: https://github.com/MetaMask/metamask-extension/issues/12768
2022-08-04 20:12:06 +02:00
const BUILD_TARGETS = {
Add validation to production build script (#15468) Validation has been added to the build script when the "prod" target is selected. We now ensure that all expected environment variables are set, and that no extra environment variables are present (which might indicate that the wrong configuration file is being used). The `prod` target uses a new `.metamaskprodrc` configuration file. Each required variable can be specified either via environment variable or via this config file. CI will continue set these via environment variable, but for local manual builds we can use the config file to simplify the build process and ensure consistency. A new "dist" target has been added to preserve the ability to build a "production-like" build without this validation. The config validation is invoked early in the script, in the CLI argument parsing step, so that it would fail more quickly. Otherwise we'd have to wait a few minutes longer for the validation to run. This required some refactoring, moving functions to the utility module and moving the config to a dedicated module. Additionally, support has been added for all environment variables to be set via the config file. Previously the values `PUBNUB_PUB_KEY`, `PUBNUB_SUB_KEY`, `SENTRY_DSN`, and `SWAPS_USE_DEV_APIS` could only be set via environment variable. Now, all of these variables can be set either way. Closes #15003
2022-08-19 20:16:18 +02:00
DEV: 'dev',
DIST: 'dist',
PROD: 'prod',
TEST: 'test',
TEST_DEV: 'testDev',
};
/**
* The build environment. This describes the environment this build was produced in.
*/
const ENVIRONMENT = {
DEVELOPMENT: 'development',
PRODUCTION: 'production',
OTHER: 'other',
PULL_REQUEST: 'pull-request',
RELEASE_CANDIDATE: 'release-candidate',
STAGING: 'staging',
TESTING: 'testing',
Refactor build script to include build target (#15447) The "scripts" portion of the build script has been refactored to pass the "build target" throughout the file. The "build target" is the target environment for the build, reflected by the command used to start the build (e.g. "dev", "prod", "test", or "testDev"). Beforehand we derived the variables `devMode` and `testing` from this build target, and passed these throughout the script. However, there is a future change [1] that requires adding a new build target that acts like "prod" in some ways but not others. It was easier to refactor to pass through `buildTarget` directly than it was to add a _third_ boolean flag to indirectly represent the target. The existence of the "testDev" target made it convenient to still have the `testing` and `devMode` flag, so helper functions were added to derive those values from the build target. I anticipate that these will only be needed temporarily though. We will probably be able to get rid of the `testDev` target and the related complexities when we start adding more flags (like `--watch`[2] and `--minify`[3]) to the build script directly. [1]: https://github.com/MetaMask/metamask-extension/issues/15003 [2]: https://github.com/MetaMask/metamask-extension/issues/12767 [3]: https://github.com/MetaMask/metamask-extension/issues/12768
2022-08-04 20:12:06 +02:00
};
Migrate the build script to `yargs` (#14836) The build script now uses `yargs` rather than `minimist`. The CLI is now better documented, and we have additional validation for each option. A patch for `yargs` was required because it would blow up on the line `Error.captureStackTrace`. For some reason when running under LavaMoat, that property did not exist. Closes #12766
2022-06-21 22:07:05 +02:00
const TASKS = {
Add validation to production build script (#15468) Validation has been added to the build script when the "prod" target is selected. We now ensure that all expected environment variables are set, and that no extra environment variables are present (which might indicate that the wrong configuration file is being used). The `prod` target uses a new `.metamaskprodrc` configuration file. Each required variable can be specified either via environment variable or via this config file. CI will continue set these via environment variable, but for local manual builds we can use the config file to simplify the build process and ensure consistency. A new "dist" target has been added to preserve the ability to build a "production-like" build without this validation. The config validation is invoked early in the script, in the CLI argument parsing step, so that it would fail more quickly. Otherwise we'd have to wait a few minutes longer for the validation to run. This required some refactoring, moving functions to the utility module and moving the config to a dedicated module. Additionally, support has been added for all environment variables to be set via the config file. Previously the values `PUBNUB_PUB_KEY`, `PUBNUB_SUB_KEY`, `SENTRY_DSN`, and `SWAPS_USE_DEV_APIS` could only be set via environment variable. Now, all of these variables can be set either way. Closes #15003
2022-08-19 20:16:18 +02:00
...BUILD_TARGETS,
Migrate the build script to `yargs` (#14836) The build script now uses `yargs` rather than `minimist`. The CLI is now better documented, and we have additional validation for each option. A patch for `yargs` was required because it would blow up on the line `Error.captureStackTrace`. For some reason when running under LavaMoat, that property did not exist. Closes #12766
2022-06-21 22:07:05 +02:00
CLEAN: 'clean',
LINT_SCSS: 'lint-scss',
MANIFEST_DEV: 'manifest:dev',
MANIFEST_PROD: 'manifest:prod',
MANIFEST_TEST: 'manifest:test',
MANIFEST_TEST_DEV: 'manifest:testDev',
RELOAD: 'reload',
SCRIPTS_CORE_DEV_STANDARD_ENTRY_POINTS:
'scripts:core:dev:standardEntryPoints',
SCRIPTS_CORE_DEV_CONTENTSCRIPT: 'scripts:core:dev:contentscript',
SCRIPTS_CORE_DEV_DISABLE_CONSOLE: 'scripts:core:dev:disable-console',
SCRIPTS_CORE_DEV_SENTRY: 'scripts:core:dev:sentry',
SCRIPTS_CORE_DEV_PHISHING_DETECT: 'scripts:core:dev:phishing-detect',
Add validation to production build script (#15468) Validation has been added to the build script when the "prod" target is selected. We now ensure that all expected environment variables are set, and that no extra environment variables are present (which might indicate that the wrong configuration file is being used). The `prod` target uses a new `.metamaskprodrc` configuration file. Each required variable can be specified either via environment variable or via this config file. CI will continue set these via environment variable, but for local manual builds we can use the config file to simplify the build process and ensure consistency. A new "dist" target has been added to preserve the ability to build a "production-like" build without this validation. The config validation is invoked early in the script, in the CLI argument parsing step, so that it would fail more quickly. Otherwise we'd have to wait a few minutes longer for the validation to run. This required some refactoring, moving functions to the utility module and moving the config to a dedicated module. Additionally, support has been added for all environment variables to be set via the config file. Previously the values `PUBNUB_PUB_KEY`, `PUBNUB_SUB_KEY`, `SENTRY_DSN`, and `SWAPS_USE_DEV_APIS` could only be set via environment variable. Now, all of these variables can be set either way. Closes #15003
2022-08-19 20:16:18 +02:00
SCRIPTS_CORE_DIST_STANDARD_ENTRY_POINTS:
'scripts:core:dist:standardEntryPoints',
SCRIPTS_CORE_DIST_CONTENTSCRIPT: 'scripts:core:dist:contentscript',
SCRIPTS_CORE_DIST_DISABLE_CONSOLE: 'scripts:core:dist:disable-console',
SCRIPTS_CORE_DIST_SENTRY: 'scripts:core:dist:sentry',
SCRIPTS_CORE_DIST_PHISHING_DETECT: 'scripts:core:dist:phishing-detect',
Migrate the build script to `yargs` (#14836) The build script now uses `yargs` rather than `minimist`. The CLI is now better documented, and we have additional validation for each option. A patch for `yargs` was required because it would blow up on the line `Error.captureStackTrace`. For some reason when running under LavaMoat, that property did not exist. Closes #12766
2022-06-21 22:07:05 +02:00
SCRIPTS_CORE_PROD_STANDARD_ENTRY_POINTS:
'scripts:core:prod:standardEntryPoints',
SCRIPTS_CORE_PROD_CONTENTSCRIPT: 'scripts:core:prod:contentscript',
SCRIPTS_CORE_PROD_DISABLE_CONSOLE: 'scripts:core:prod:disable-console',
SCRIPTS_CORE_PROD_SENTRY: 'scripts:core:prod:sentry',
SCRIPTS_CORE_PROD_PHISHING_DETECT: 'scripts:core:prod:phishing-detect',
SCRIPTS_CORE_TEST_LIVE_STANDARD_ENTRY_POINTS:
'scripts:core:test-live:standardEntryPoints',
SCRIPTS_CORE_TEST_LIVE_CONTENTSCRIPT: 'scripts:core:test-live:contentscript',
SCRIPTS_CORE_TEST_LIVE_DISABLE_CONSOLE:
'scripts:core:test-live:disable-console',
SCRIPTS_CORE_TEST_LIVE_SENTRY: 'scripts:core:test-live:sentry',
SCRIPTS_CORE_TEST_LIVE_PHISHING_DETECT:
'scripts:core:test-live:phishing-detect',
SCRIPTS_CORE_TEST_STANDARD_ENTRY_POINTS:
'scripts:core:test:standardEntryPoints',
SCRIPTS_CORE_TEST_CONTENTSCRIPT: 'scripts:core:test:contentscript',
SCRIPTS_CORE_TEST_DISABLE_CONSOLE: 'scripts:core:test:disable-console',
SCRIPTS_CORE_TEST_SENTRY: 'scripts:core:test:sentry',
SCRIPTS_CORE_TEST_PHISHING_DETECT: 'scripts:core:test:phishing-detect',
Add validation to production build script (#15468) Validation has been added to the build script when the "prod" target is selected. We now ensure that all expected environment variables are set, and that no extra environment variables are present (which might indicate that the wrong configuration file is being used). The `prod` target uses a new `.metamaskprodrc` configuration file. Each required variable can be specified either via environment variable or via this config file. CI will continue set these via environment variable, but for local manual builds we can use the config file to simplify the build process and ensure consistency. A new "dist" target has been added to preserve the ability to build a "production-like" build without this validation. The config validation is invoked early in the script, in the CLI argument parsing step, so that it would fail more quickly. Otherwise we'd have to wait a few minutes longer for the validation to run. This required some refactoring, moving functions to the utility module and moving the config to a dedicated module. Additionally, support has been added for all environment variables to be set via the config file. Previously the values `PUBNUB_PUB_KEY`, `PUBNUB_SUB_KEY`, `SENTRY_DSN`, and `SWAPS_USE_DEV_APIS` could only be set via environment variable. Now, all of these variables can be set either way. Closes #15003
2022-08-19 20:16:18 +02:00
SCRIPTS_DIST: 'scripts:dist',
Migrate the build script to `yargs` (#14836) The build script now uses `yargs` rather than `minimist`. The CLI is now better documented, and we have additional validation for each option. A patch for `yargs` was required because it would blow up on the line `Error.captureStackTrace`. For some reason when running under LavaMoat, that property did not exist. Closes #12766
2022-06-21 22:07:05 +02:00
STATIC_DEV: 'static:dev',
STATIC_PROD: 'static:prod',
STYLES: 'styles',
STYLES_DEV: 'styles:dev',
STYLES_PROD: 'styles:prod',
ZIP: 'zip',
};
Add validation to production build script (#15468) Validation has been added to the build script when the "prod" target is selected. We now ensure that all expected environment variables are set, and that no extra environment variables are present (which might indicate that the wrong configuration file is being used). The `prod` target uses a new `.metamaskprodrc` configuration file. Each required variable can be specified either via environment variable or via this config file. CI will continue set these via environment variable, but for local manual builds we can use the config file to simplify the build process and ensure consistency. A new "dist" target has been added to preserve the ability to build a "production-like" build without this validation. The config validation is invoked early in the script, in the CLI argument parsing step, so that it would fail more quickly. Otherwise we'd have to wait a few minutes longer for the validation to run. This required some refactoring, moving functions to the utility module and moving the config to a dedicated module. Additionally, support has been added for all environment variables to be set via the config file. Previously the values `PUBNUB_PUB_KEY`, `PUBNUB_SUB_KEY`, `SENTRY_DSN`, and `SWAPS_USE_DEV_APIS` could only be set via environment variable. Now, all of these variables can be set either way. Closes #15003
2022-08-19 20:16:18 +02:00
module.exports = { BUILD_TARGETS, ENVIRONMENT, TASKS };
Copy Permalink