2019-11-14 17:47:32 +01:00
version : 2.1
2018-03-09 21:47:01 +01:00
2020-12-11 18:37:13 +01:00
executors :
node-browsers :
docker :
2023-05-02 17:10:53 +02:00
- image : cimg/node:16.20-browsers
2020-12-11 18:37:13 +01:00
node-browsers-medium-plus :
docker :
2023-05-02 17:10:53 +02:00
- image : cimg/node:16.20-browsers
2020-12-11 18:37:13 +01:00
resource_class : medium+
environment :
NODE_OPTIONS : --max_old_space_size=2048
2023-05-18 04:07:42 +02:00
node-browsers-large :
docker :
- image : cimg/node:16.20-browsers
resource_class : large
environment :
NODE_OPTIONS : --max_old_space_size=2048
2020-12-11 18:37:13 +01:00
shellcheck :
docker :
2021-11-19 01:58:31 +01:00
- image : koalaman/shellcheck-alpine@sha256:dfaf08fab58c158549d3be64fb101c626abc5f16f341b569092577ae207db199
2020-12-11 18:37:13 +01:00
2022-11-24 20:59:07 +01:00
orbs :
gh : circleci/github-cli@2.0
2023-01-11 19:23:38 +01:00
codecov : codecov/codecov@3.2.2
2022-11-24 20:59:07 +01:00
2023-03-04 13:51:04 +01:00
rc_branch_only : &rc_branch_only
filters :
branches :
only :
- /^Version-v(\d+)[.](\d+)[.](\d+)/
2023-06-27 19:57:46 +02:00
aliases :
# Shallow Git Clone
- &shallow-git-clone
name : Shallow Git Clone
command : |
#!/bin/bash
set -e
set -u
set -o pipefail
# This Shallow Git Clone code is adapted from what the standard CircleCI `checkout` command does for the case of an external PR (link to example below):
# https://app.circleci.com/pipelines/github/MetaMask/metamask-extension/49817/workflows/dc195ea6-ac06-4de1-9edf-4c949427b5fb/jobs/1430976/parallel-runs/0/steps/0-101
### git clone --no-checkout "$CIRCLE_REPOSITORY_URL" .
### git fetch --force origin +refs/pull/18748/head:refs/remotes/origin/pull/18748
### git checkout --force -B "$CIRCLE_BRANCH" "$CIRCLE_SHA1"
### git --no-pager log --no-color -n 1 --format='HEAD is now at %h %s'
# Set up SSH access
# This SSH key is the current github.com SSH key as of June 2023, but it will need to be changed whenever github changes their key (probably every few years)
GITHUB_SSH_KEY="AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl"
mkdir -p ~/.ssh
echo github.com ssh-ed25519 $GITHUB_SSH_KEY >> ~/.ssh/known_hosts
# Take a different clone path depending on if it's a tag, a PR from an external repo, or the normal case
if [ -n "${CIRCLE_TAG-}" ]; then
# tag
git clone --depth 1 --no-checkout "$CIRCLE_REPOSITORY_URL" .
git fetch --depth 1 --force origin "+refs/tags/${CIRCLE_TAG}:refs/tags/${CIRCLE_TAG}"
git checkout --force -q "$CIRCLE_TAG" "$CIRCLE_SHA1"
elif [[ "$CIRCLE_BRANCH" =~ ^pull\/* ]]; then
# pull request
git clone --depth 1 --no-checkout "$CIRCLE_REPOSITORY_URL" .
git fetch --depth 1 --force origin "${CIRCLE_BRANCH}/head:remotes/origin/${CIRCLE_BRANCH}"
git checkout --force -B "$CIRCLE_BRANCH" "$CIRCLE_SHA1"
else
# normal case
git clone --depth 1 "$CIRCLE_REPOSITORY_URL" --branch "$CIRCLE_BRANCH" .
fi
2018-03-09 21:47:01 +01:00
workflows :
2019-07-18 07:51:47 +02:00
test_and_release :
2018-03-09 21:47:01 +01:00
jobs :
2019-07-18 07:51:47 +02:00
- create_release_pull_request :
2023-03-04 13:51:04 +01:00
<< : *rc_branch_only
requires :
- prep-deps
- trigger-beta-build :
2020-10-06 19:57:59 +02:00
requires :
- prep-deps
Switch from `npm` to `yarn` (#6843)
As a solution to the constant lockfile churn issues we've had with
`npm`, the project now uses `yarn` to manage dependencies.
The `package-lock.json` file has been replaced with `yarn.lock`, which
was created using `yarn import`. It should approximate the contents of
`package-lock.json` fairly well, though there may be some changes due to
deduplication. The codeowners file has been updated to reference this
new lockfile.
All documentation and npm scripts have been updated to reference `yarn`
rather than `npm`. Note that running scripts using `npm run` still works
fine, but it seemed better to switch those to `yarn` as well to avoid
confusion.
The `npm-audit` Bash script has been replaced with `yarn-audit`. The
output of `yarn audit` is a bit different than `npm audit` in that it
returns a bitmask to describe which severity issues were found. This
made it simpler to check the results directly from the Bash script, so
the associated `npm-audit-check.js` script was no longer required. The
output should be exactly the same, and the information is still sourced
from the same place (the npm registry).
The new `yarn-audit` script does have an external dependency: `jq`.
However, `jq` is already assumed to be present by another CI script, and
is present on all CI images we use. `jq` was not added to `package.json`
as a dependency because there is no official package on the npm
registry, just wrapper scripts. We don't need it anywhere exept on CI
anyway.
The section in `CONTRIBUTING` about how to develop inside the
`node_modules` folder was removed, as the advice was a bit dated, and
wasn't specific to this project anyway.
2019-07-30 20:36:23 +02:00
- prep-deps
2021-11-18 21:57:47 +01:00
- test-deps-audit :
requires :
- prep-deps
2021-07-28 05:03:03 +02:00
- test-deps-depcheck :
requires :
- prep-deps
2021-11-23 20:17:27 +01:00
- test-yarn-dedupe :
requires :
- prep-deps
2023-06-22 23:10:32 +02:00
- validate-lavamoat-allow-scripts :
requires :
- prep-deps
- validate-lavamoat-policy-build :
requires :
- prep-deps
- validate-lavamoat-policy-webapp :
matrix :
parameters :
build-type : [ main, beta, flask, mmi, desktop]
2021-02-24 16:52:28 +01:00
requires :
- prep-deps
2018-03-27 23:16:58 +02:00
- prep-build :
2018-03-27 23:08:20 +02:00
requires :
Switch from `npm` to `yarn` (#6843)
As a solution to the constant lockfile churn issues we've had with
`npm`, the project now uses `yarn` to manage dependencies.
The `package-lock.json` file has been replaced with `yarn.lock`, which
was created using `yarn import`. It should approximate the contents of
`package-lock.json` fairly well, though there may be some changes due to
deduplication. The codeowners file has been updated to reference this
new lockfile.
All documentation and npm scripts have been updated to reference `yarn`
rather than `npm`. Note that running scripts using `npm run` still works
fine, but it seemed better to switch those to `yarn` as well to avoid
confusion.
The `npm-audit` Bash script has been replaced with `yarn-audit`. The
output of `yarn audit` is a bit different than `npm audit` in that it
returns a bitmask to describe which severity issues were found. This
made it simpler to check the results directly from the Bash script, so
the associated `npm-audit-check.js` script was no longer required. The
output should be exactly the same, and the information is still sourced
from the same place (the npm registry).
The new `yarn-audit` script does have an external dependency: `jq`.
However, `jq` is already assumed to be present by another CI script, and
is present on all CI images we use. `jq` was not added to `package.json`
as a dependency because there is no official package on the npm
registry, just wrapper scripts. We don't need it anywhere exept on CI
anyway.
The section in `CONTRIBUTING` about how to develop inside the
`node_modules` folder was removed, as the advice was a bit dated, and
wasn't specific to this project anyway.
2019-07-30 20:36:23 +02:00
- prep-deps
2023-02-08 10:24:01 +01:00
- prep-build-desktop :
2023-03-13 12:42:01 +01:00
filters :
branches :
ignore : master
2023-02-08 10:24:01 +01:00
requires :
- prep-deps
2021-11-04 19:44:48 +01:00
- prep-build-flask :
requires :
- prep-deps
2020-01-20 18:03:21 +01:00
- prep-build-test :
requires :
- prep-deps
2022-07-14 01:34:33 +02:00
- prep-build-test-mv3 :
requires :
- prep-deps
2022-03-10 23:01:55 +01:00
- prep-build-test-flask :
requires :
- prep-deps
2021-11-24 01:41:30 +01:00
- prep-build-storybook :
requires :
2022-11-18 16:32:20 +01:00
- prep-deps
Add TypeScript migration dashboard (#13820)
As we convert parts of the codebase to TypeScript, we will want a way to
track progress. This commit adds a dashboard which displays all of the
files that we wish to convert to TypeScript and which files we've
already converted.
The list of all possible files to convert is predetermined by walking
the dependency graph of each entrypoint the build system uses to compile
the extension (the files that the entrypoint imports, the files that the
imports import, etc). The list should not need to be regenerated, but
you can do it by running:
yarn ts-migration:enumerate
The dashboard is implemented as a separate React app. The CircleCI
configuration has been updated so that when a new commit is pushed, the
React app is built and stored in the CircleCI artifacts. When a PR is
merged, the built files will be pushed to a separate repo whose sole
purpose is to serve the dashboard via GitHub Pages (this is the same
way that the Storybook works). All of the app code and script to build
the app are self-contained under
`development/ts-migration-dashboard`. To build this app yourself, you
can run:
yarn ts-migration:dashboard:build
or if you want to build automatically as you change files, run:
yarn ts-migration:dashboard:watch
Then open the following file in your browser (there is no server
component):
development/ts-migration-dashboard/build/index.html
Finally, although you shouldn't have to do this, to manually deploy the
dashboard once built, you can run:
git remote add ts-migration-dashboard git@github.com:MetaMask/metamask-extension-ts-migration-dashboard.git
yarn ts-migration:dashboard:deploy
2022-08-09 22:16:08 +02:00
- prep-build-ts-migration-dashboard :
requires :
- prep-deps
2018-03-09 22:15:36 +01:00
- test-lint :
2018-03-09 21:47:01 +01:00
requires :
Switch from `npm` to `yarn` (#6843)
As a solution to the constant lockfile churn issues we've had with
`npm`, the project now uses `yarn` to manage dependencies.
The `package-lock.json` file has been replaced with `yarn.lock`, which
was created using `yarn import`. It should approximate the contents of
`package-lock.json` fairly well, though there may be some changes due to
deduplication. The codeowners file has been updated to reference this
new lockfile.
All documentation and npm scripts have been updated to reference `yarn`
rather than `npm`. Note that running scripts using `npm run` still works
fine, but it seemed better to switch those to `yarn` as well to avoid
confusion.
The `npm-audit` Bash script has been replaced with `yarn-audit`. The
output of `yarn audit` is a bit different than `npm audit` in that it
returns a bitmask to describe which severity issues were found. This
made it simpler to check the results directly from the Bash script, so
the associated `npm-audit-check.js` script was no longer required. The
output should be exactly the same, and the information is still sourced
from the same place (the npm registry).
The new `yarn-audit` script does have an external dependency: `jq`.
However, `jq` is already assumed to be present by another CI script, and
is present on all CI images we use. `jq` was not added to `package.json`
as a dependency because there is no official package on the npm
registry, just wrapper scripts. We don't need it anywhere exept on CI
anyway.
The section in `CONTRIBUTING` about how to develop inside the
`node_modules` folder was removed, as the advice was a bit dated, and
wasn't specific to this project anyway.
2019-07-30 20:36:23 +02:00
- prep-deps
2019-11-19 16:46:10 +01:00
- test-lint-shellcheck
2020-01-06 19:58:43 +01:00
- test-lint-lockfile :
requires :
- prep-deps
2021-05-06 20:55:50 +02:00
- test-lint-changelog :
requires :
- prep-deps
2019-02-20 14:57:49 +01:00
- test-e2e-chrome :
2018-05-28 18:22:48 +02:00
requires :
2020-01-20 18:03:21 +01:00
- prep-build-test
2019-02-20 14:57:49 +01:00
- test-e2e-firefox :
2018-05-28 18:22:48 +02:00
requires :
2020-01-20 18:03:21 +01:00
- prep-build-test
2022-03-10 23:01:55 +01:00
- test-e2e-chrome-snaps :
requires :
- prep-build-test-flask
- test-e2e-firefox-snaps :
requires :
- prep-build-test-flask
2022-10-10 14:33:13 +02:00
- test-e2e-chrome-mv3 :
requires :
- prep-build-test-mv3
2023-01-11 19:23:38 +01:00
- test-unit-mocha :
2018-03-09 22:15:36 +01:00
requires :
Switch from `npm` to `yarn` (#6843)
As a solution to the constant lockfile churn issues we've had with
`npm`, the project now uses `yarn` to manage dependencies.
The `package-lock.json` file has been replaced with `yarn.lock`, which
was created using `yarn import`. It should approximate the contents of
`package-lock.json` fairly well, though there may be some changes due to
deduplication. The codeowners file has been updated to reference this
new lockfile.
All documentation and npm scripts have been updated to reference `yarn`
rather than `npm`. Note that running scripts using `npm run` still works
fine, but it seemed better to switch those to `yarn` as well to avoid
confusion.
The `npm-audit` Bash script has been replaced with `yarn-audit`. The
output of `yarn audit` is a bit different than `npm audit` in that it
returns a bitmask to describe which severity issues were found. This
made it simpler to check the results directly from the Bash script, so
the associated `npm-audit-check.js` script was no longer required. The
output should be exactly the same, and the information is still sourced
from the same place (the npm registry).
The new `yarn-audit` script does have an external dependency: `jq`.
However, `jq` is already assumed to be present by another CI script, and
is present on all CI images we use. `jq` was not added to `package.json`
as a dependency because there is no official package on the npm
registry, just wrapper scripts. We don't need it anywhere exept on CI
anyway.
The section in `CONTRIBUTING` about how to develop inside the
`node_modules` folder was removed, as the advice was a bit dated, and
wasn't specific to this project anyway.
2019-07-30 20:36:23 +02:00
- prep-deps
2023-01-11 19:23:38 +01:00
- test-unit-jest-main :
requires :
- prep-deps
- test-unit-jest-development :
requires :
- prep-deps
- upload-and-validate-coverage :
requires :
- test-unit-jest-main
- test-unit-jest-development
- test-unit-mocha
2019-10-24 15:54:32 +02:00
- test-unit-global :
requires :
- prep-deps
2023-01-20 20:27:46 +01:00
- test-storybook :
requires :
- prep-deps
- prep-build-storybook
2020-08-04 19:21:46 +02:00
- validate-source-maps :
requires :
- prep-build
2021-11-04 19:44:48 +01:00
- validate-source-maps-beta :
requires :
2023-03-04 13:51:04 +01:00
- trigger-beta-build
2023-02-08 10:24:01 +01:00
- validate-source-maps-desktop :
2023-03-13 12:42:01 +01:00
filters :
branches :
ignore : master
2023-02-08 10:24:01 +01:00
requires :
- prep-build-desktop
2021-11-04 19:44:48 +01:00
- validate-source-maps-flask :
requires :
- prep-build-flask
2018-09-26 02:44:57 +02:00
- test-mozilla-lint :
requires :
Switch from `npm` to `yarn` (#6843)
As a solution to the constant lockfile churn issues we've had with
`npm`, the project now uses `yarn` to manage dependencies.
The `package-lock.json` file has been replaced with `yarn.lock`, which
was created using `yarn import`. It should approximate the contents of
`package-lock.json` fairly well, though there may be some changes due to
deduplication. The codeowners file has been updated to reference this
new lockfile.
All documentation and npm scripts have been updated to reference `yarn`
rather than `npm`. Note that running scripts using `npm run` still works
fine, but it seemed better to switch those to `yarn` as well to avoid
confusion.
The `npm-audit` Bash script has been replaced with `yarn-audit`. The
output of `yarn audit` is a bit different than `npm audit` in that it
returns a bitmask to describe which severity issues were found. This
made it simpler to check the results directly from the Bash script, so
the associated `npm-audit-check.js` script was no longer required. The
output should be exactly the same, and the information is still sourced
from the same place (the npm registry).
The new `yarn-audit` script does have an external dependency: `jq`.
However, `jq` is already assumed to be present by another CI script, and
is present on all CI images we use. `jq` was not added to `package.json`
as a dependency because there is no official package on the npm
registry, just wrapper scripts. We don't need it anywhere exept on CI
anyway.
The section in `CONTRIBUTING` about how to develop inside the
`node_modules` folder was removed, as the advice was a bit dated, and
wasn't specific to this project anyway.
2019-07-30 20:36:23 +02:00
- prep-deps
2018-09-26 02:44:57 +02:00
- prep-build
2023-02-08 10:24:01 +01:00
- test-mozilla-lint-desktop :
2023-03-13 12:42:01 +01:00
filters :
branches :
ignore : master
2023-02-08 10:24:01 +01:00
requires :
- prep-deps
- prep-build-desktop
2021-11-04 19:44:48 +01:00
- test-mozilla-lint-flask :
requires :
- prep-deps
- prep-build-flask
2018-03-28 01:09:11 +02:00
- all-tests-pass :
2018-03-27 23:40:04 +02:00
requires :
2023-06-22 23:10:32 +02:00
- validate-lavamoat-allow-scripts
- validate-lavamoat-policy-build
- validate-lavamoat-policy-webapp
2018-03-27 23:40:04 +02:00
- test-lint
2019-11-19 16:46:10 +01:00
- test-lint-shellcheck
2020-01-06 19:58:43 +01:00
- test-lint-lockfile
2021-05-06 20:55:50 +02:00
- test-lint-changelog
2023-01-11 19:23:38 +01:00
- test-unit-jest-main
- test-unit-jest-development
2019-10-24 15:54:32 +02:00
- test-unit-global
2023-01-11 19:23:38 +01:00
- test-unit-mocha
- upload-and-validate-coverage
2020-08-04 19:21:46 +02:00
- validate-source-maps
2021-11-04 19:44:48 +01:00
- validate-source-maps-beta
2023-02-08 10:24:01 +01:00
- validate-source-maps-desktop
2021-11-04 19:44:48 +01:00
- validate-source-maps-flask
2018-09-26 02:44:57 +02:00
- test-mozilla-lint
2023-02-08 10:24:01 +01:00
- test-mozilla-lint-desktop
2021-11-04 19:44:48 +01:00
- test-mozilla-lint-flask
2019-02-20 14:57:49 +01:00
- test-e2e-chrome
- test-e2e-firefox
2022-03-10 23:01:55 +01:00
- test-e2e-chrome-snaps
- test-e2e-firefox-snaps
2023-01-20 20:27:46 +01:00
- test-storybook
2020-01-23 21:55:17 +01:00
- benchmark :
requires :
- prep-build-test
2022-08-12 19:41:20 +02:00
- user-actions-benchmark :
requires :
- prep-build-test
2022-07-20 17:33:16 +02:00
- stats-module-load-init :
requires :
- prep-build-test-mv3
2018-05-18 20:10:42 +02:00
- job-publish-prerelease :
2018-04-09 22:55:19 +02:00
requires :
Switch from `npm` to `yarn` (#6843)
As a solution to the constant lockfile churn issues we've had with
`npm`, the project now uses `yarn` to manage dependencies.
The `package-lock.json` file has been replaced with `yarn.lock`, which
was created using `yarn import`. It should approximate the contents of
`package-lock.json` fairly well, though there may be some changes due to
deduplication. The codeowners file has been updated to reference this
new lockfile.
All documentation and npm scripts have been updated to reference `yarn`
rather than `npm`. Note that running scripts using `npm run` still works
fine, but it seemed better to switch those to `yarn` as well to avoid
confusion.
The `npm-audit` Bash script has been replaced with `yarn-audit`. The
output of `yarn audit` is a bit different than `npm audit` in that it
returns a bitmask to describe which severity issues were found. This
made it simpler to check the results directly from the Bash script, so
the associated `npm-audit-check.js` script was no longer required. The
output should be exactly the same, and the information is still sourced
from the same place (the npm registry).
The new `yarn-audit` script does have an external dependency: `jq`.
However, `jq` is already assumed to be present by another CI script, and
is present on all CI images we use. `jq` was not added to `package.json`
as a dependency because there is no official package on the npm
registry, just wrapper scripts. We don't need it anywhere exept on CI
anyway.
The section in `CONTRIBUTING` about how to develop inside the
`node_modules` folder was removed, as the advice was a bit dated, and
wasn't specific to this project anyway.
2019-07-30 20:36:23 +02:00
- prep-deps
2018-04-09 22:55:19 +02:00
- prep-build
2023-03-04 13:51:04 +01:00
- trigger-beta-build
2023-02-08 10:24:01 +01:00
- prep-build-desktop
2021-11-04 19:44:48 +01:00
- prep-build-flask
2021-02-04 15:30:22 +01:00
- prep-build-storybook
Add TypeScript migration dashboard (#13820)
As we convert parts of the codebase to TypeScript, we will want a way to
track progress. This commit adds a dashboard which displays all of the
files that we wish to convert to TypeScript and which files we've
already converted.
The list of all possible files to convert is predetermined by walking
the dependency graph of each entrypoint the build system uses to compile
the extension (the files that the entrypoint imports, the files that the
imports import, etc). The list should not need to be regenerated, but
you can do it by running:
yarn ts-migration:enumerate
The dashboard is implemented as a separate React app. The CircleCI
configuration has been updated so that when a new commit is pushed, the
React app is built and stored in the CircleCI artifacts. When a PR is
merged, the built files will be pushed to a separate repo whose sole
purpose is to serve the dashboard via GitHub Pages (this is the same
way that the Storybook works). All of the app code and script to build
the app are self-contained under
`development/ts-migration-dashboard`. To build this app yourself, you
can run:
yarn ts-migration:dashboard:build
or if you want to build automatically as you change files, run:
yarn ts-migration:dashboard:watch
Then open the following file in your browser (there is no server
component):
development/ts-migration-dashboard/build/index.html
Finally, although you shouldn't have to do this, to manually deploy the
dashboard once built, you can run:
git remote add ts-migration-dashboard git@github.com:MetaMask/metamask-extension-ts-migration-dashboard.git
yarn ts-migration:dashboard:deploy
2022-08-09 22:16:08 +02:00
- prep-build-ts-migration-dashboard
2022-07-20 17:33:16 +02:00
- prep-build-test-mv3
2020-01-23 21:55:17 +01:00
- benchmark
2022-08-12 19:41:20 +02:00
- user-actions-benchmark
2022-07-20 17:33:16 +02:00
- stats-module-load-init
2018-04-09 22:55:19 +02:00
- all-tests-pass
2018-05-18 20:29:10 +02:00
- job-publish-release :
filters :
branches :
only : master
requires :
Switch from `npm` to `yarn` (#6843)
As a solution to the constant lockfile churn issues we've had with
`npm`, the project now uses `yarn` to manage dependencies.
The `package-lock.json` file has been replaced with `yarn.lock`, which
was created using `yarn import`. It should approximate the contents of
`package-lock.json` fairly well, though there may be some changes due to
deduplication. The codeowners file has been updated to reference this
new lockfile.
All documentation and npm scripts have been updated to reference `yarn`
rather than `npm`. Note that running scripts using `npm run` still works
fine, but it seemed better to switch those to `yarn` as well to avoid
confusion.
The `npm-audit` Bash script has been replaced with `yarn-audit`. The
output of `yarn audit` is a bit different than `npm audit` in that it
returns a bitmask to describe which severity issues were found. This
made it simpler to check the results directly from the Bash script, so
the associated `npm-audit-check.js` script was no longer required. The
output should be exactly the same, and the information is still sourced
from the same place (the npm registry).
The new `yarn-audit` script does have an external dependency: `jq`.
However, `jq` is already assumed to be present by another CI script, and
is present on all CI images we use. `jq` was not added to `package.json`
as a dependency because there is no official package on the npm
registry, just wrapper scripts. We don't need it anywhere exept on CI
anyway.
The section in `CONTRIBUTING` about how to develop inside the
`node_modules` folder was removed, as the advice was a bit dated, and
wasn't specific to this project anyway.
2019-07-30 20:36:23 +02:00
- prep-deps
2018-05-18 20:29:10 +02:00
- prep-build
2023-02-08 10:24:01 +01:00
- prep-build-desktop
2022-03-15 12:24:37 +01:00
- prep-build-flask
2018-05-18 20:29:10 +02:00
- all-tests-pass
2020-02-08 20:56:33 +01:00
- job-publish-storybook :
filters :
branches :
only : develop
requires :
- prep-build-storybook
Add TypeScript migration dashboard (#13820)
As we convert parts of the codebase to TypeScript, we will want a way to
track progress. This commit adds a dashboard which displays all of the
files that we wish to convert to TypeScript and which files we've
already converted.
The list of all possible files to convert is predetermined by walking
the dependency graph of each entrypoint the build system uses to compile
the extension (the files that the entrypoint imports, the files that the
imports import, etc). The list should not need to be regenerated, but
you can do it by running:
yarn ts-migration:enumerate
The dashboard is implemented as a separate React app. The CircleCI
configuration has been updated so that when a new commit is pushed, the
React app is built and stored in the CircleCI artifacts. When a PR is
merged, the built files will be pushed to a separate repo whose sole
purpose is to serve the dashboard via GitHub Pages (this is the same
way that the Storybook works). All of the app code and script to build
the app are self-contained under
`development/ts-migration-dashboard`. To build this app yourself, you
can run:
yarn ts-migration:dashboard:build
or if you want to build automatically as you change files, run:
yarn ts-migration:dashboard:watch
Then open the following file in your browser (there is no server
component):
development/ts-migration-dashboard/build/index.html
Finally, although you shouldn't have to do this, to manually deploy the
dashboard once built, you can run:
git remote add ts-migration-dashboard git@github.com:MetaMask/metamask-extension-ts-migration-dashboard.git
yarn ts-migration:dashboard:deploy
2022-08-09 22:16:08 +02:00
- job-publish-ts-migration-dashboard :
filters :
branches :
only : develop
requires :
- prep-build-ts-migration-dashboard
2018-03-09 21:47:01 +01:00
2018-03-09 21:38:28 +01:00
jobs :
2023-03-04 13:51:04 +01:00
trigger-beta-build :
executor : node-browsers-medium-plus
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2023-03-04 13:51:04 +01:00
- attach_workspace :
at : .
- when :
condition :
not :
matches :
pattern : /^master$/
value : << pipeline.git.branch >>
steps :
- run :
name : Build beta prod
command : |
.circleci/scripts/trigger-beta-build.sh
- run :
name : Move beta build to 'dist-beta' to avoid conflict with production build
command : mv ./dist ./dist-beta
- run :
name : Move beta zips to 'builds-beta' to avoid conflict with production build
command : mv ./builds ./builds-beta
- persist_to_workspace :
root : .
paths :
- dist-beta
- builds-beta
2019-07-18 07:51:47 +02:00
create_release_pull_request :
2020-12-11 18:37:13 +01:00
executor : node-browsers
2019-07-18 07:51:47 +02:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2020-10-06 21:09:53 +02:00
- attach_workspace :
at : .
2021-04-02 23:11:51 +02:00
- run :
name : Bump manifest version
command : .circleci/scripts/release-bump-manifest-version.sh
- run :
name : Update changelog
2021-04-07 21:17:41 +02:00
command : yarn update-changelog --rc
2021-04-02 23:11:51 +02:00
- run :
name : Commit changes
command : .circleci/scripts/release-commit-version-bump.sh
2019-07-18 07:51:47 +02:00
- run :
name : Create GitHub Pull Request for version
2021-04-02 23:11:51 +02:00
command : .circleci/scripts/release-create-release-pr.sh
2019-07-18 07:51:47 +02:00
Switch from `npm` to `yarn` (#6843)
As a solution to the constant lockfile churn issues we've had with
`npm`, the project now uses `yarn` to manage dependencies.
The `package-lock.json` file has been replaced with `yarn.lock`, which
was created using `yarn import`. It should approximate the contents of
`package-lock.json` fairly well, though there may be some changes due to
deduplication. The codeowners file has been updated to reference this
new lockfile.
All documentation and npm scripts have been updated to reference `yarn`
rather than `npm`. Note that running scripts using `npm run` still works
fine, but it seemed better to switch those to `yarn` as well to avoid
confusion.
The `npm-audit` Bash script has been replaced with `yarn-audit`. The
output of `yarn audit` is a bit different than `npm audit` in that it
returns a bitmask to describe which severity issues were found. This
made it simpler to check the results directly from the Bash script, so
the associated `npm-audit-check.js` script was no longer required. The
output should be exactly the same, and the information is still sourced
from the same place (the npm registry).
The new `yarn-audit` script does have an external dependency: `jq`.
However, `jq` is already assumed to be present by another CI script, and
is present on all CI images we use. `jq` was not added to `package.json`
as a dependency because there is no official package on the npm
registry, just wrapper scripts. We don't need it anywhere exept on CI
anyway.
The section in `CONTRIBUTING` about how to develop inside the
`node_modules` folder was removed, as the advice was a bit dated, and
wasn't specific to this project anyway.
2019-07-30 20:36:23 +02:00
prep-deps :
2020-12-11 18:37:13 +01:00
executor : node-browsers
2018-03-09 21:38:28 +01:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2020-12-14 16:16:42 +01:00
- restore_cache :
2022-12-20 22:33:18 +01:00
keys :
# First try to get the specific cache for the checksum of the yarn.lock file.
# This cache key lookup will fail if the lock file is modified and a cache
# has not yet been persisted for the new checksum.
- dependency-cache-v1-{{ checksum "yarn.lock" }}
# To prevent having to do a full install of every node_module when
# dependencies change, restore from the last known cache of any
# branch/checksum, the install step will remove cached items that are no longer
# required and add the new dependencies, and the cache will be persisted.
- dependency-cache-v1-
2022-11-24 20:59:07 +01:00
- gh/install
- run :
name : Set IS_DRAFT environment variable
command : |
PR_NUMBER="${CIRCLE_PULL_REQUEST##*/}"
if [ -n "$PR_NUMBER" ]
then
echo "IS_DRAFT=$(gh pr view --json isDraft --jq '.isDraft' "$PR_NUMBER")" >> "$BASH_ENV"
source "$BASH_ENV"
else
echo "Not a PR; skipping"
fi
- run :
2023-07-13 00:20:31 +02:00
name : Install dependencies
2022-11-24 20:59:07 +01:00
command : |
if [[ $IS_DRAFT == 'true' ]]
then
2023-07-13 00:20:31 +02:00
# Use GitHub registry on draft PRs, allowing the use of preview builds
METAMASK_NPM_REGISTRY=https://npm.pkg.github.com yarn --immutable
2022-11-24 20:59:07 +01:00
else
2023-07-13 00:20:31 +02:00
yarn --immutable
2022-11-24 20:59:07 +01:00
fi
2020-12-14 16:16:42 +01:00
- save_cache :
2021-03-26 04:55:03 +01:00
key : dependency-cache-v1-{{ checksum "yarn.lock" }}
2020-12-14 16:16:42 +01:00
paths :
2022-12-20 22:33:18 +01:00
- .yarn/cache
2018-08-17 23:31:39 +02:00
- persist_to_workspace :
root : .
paths :
2022-07-14 01:34:33 +02:00
- node_modules
- build-artifacts
2018-03-09 23:58:02 +01:00
2023-06-22 23:10:32 +02:00
validate-lavamoat-allow-scripts :
2021-11-29 22:04:51 +01:00
executor : node-browsers-medium-plus
2021-02-24 16:52:28 +01:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2021-02-24 16:52:28 +01:00
- attach_workspace :
at : .
- run :
name : Validate allow-scripts config
2023-06-22 23:10:32 +02:00
command : yarn allow-scripts auto
2021-02-24 16:52:28 +01:00
- run :
2023-06-22 23:10:32 +02:00
name : Check working tree
command : .circleci/scripts/check-working-tree.sh
validate-lavamoat-policy-build :
executor : node-browsers-medium-plus
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2023-06-22 23:10:32 +02:00
- attach_workspace :
at : .
- run :
name : Validate LavaMoat build policy
command : yarn lavamoat:build:auto
- run :
name : Check working tree
command : .circleci/scripts/check-working-tree.sh
validate-lavamoat-policy-webapp :
executor : node-browsers-medium-plus
parameters :
build-type :
type : string
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2023-06-22 23:10:32 +02:00
- attach_workspace :
at : .
- run :
name : Validate LavaMoat << parameters.build-type >> policy
command : yarn lavamoat:webapp:auto:ci '--build-types=<< parameters.build-type >>'
- run :
name : Check working tree
command : .circleci/scripts/check-working-tree.sh
2021-02-24 16:52:28 +01:00
2018-03-27 23:16:58 +02:00
prep-build :
2020-12-11 18:37:13 +01:00
executor : node-browsers-medium-plus
2018-03-27 23:16:58 +02:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2018-08-17 23:31:39 +02:00
- attach_workspace :
at : .
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
- when :
condition :
not :
matches :
pattern : /^master$/
value : << pipeline.git.branch >>
steps :
- run :
name : build:dist
command : yarn build dist
- when :
condition :
matches :
pattern : /^master$/
value : << pipeline.git.branch >>
steps :
- run :
name : build:prod
command : yarn build prod
2018-03-27 23:16:58 +02:00
- run :
name : build:debug
command : find dist/ -type f -exec md5sum {} \; | sort -k 2
2018-08-17 23:31:39 +02:00
- persist_to_workspace :
root : .
2018-03-27 23:16:58 +02:00
paths :
- dist
2018-03-31 02:59:15 +02:00
- builds
2018-03-09 23:27:27 +01:00
2023-02-08 10:24:01 +01:00
prep-build-desktop :
executor : node-browsers-medium-plus
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2023-02-08 10:24:01 +01:00
- attach_workspace :
at : .
2023-03-13 12:42:01 +01:00
- run :
name : build:dist
command : yarn build --build-type desktop dist
2023-02-08 10:24:01 +01:00
- run :
name : build:debug
command : find dist/ -type f -exec md5sum {} \; | sort -k 2
- run :
name : Move desktop build to 'dist-desktop' to avoid conflict with production build
command : mv ./dist ./dist-desktop
- run :
name : Move desktop zips to 'builds-desktop' to avoid conflict with production build
command : mv ./builds ./builds-desktop
- persist_to_workspace :
root : .
paths :
- dist-desktop
- builds-desktop
2021-11-04 19:44:48 +01:00
prep-build-flask :
executor : node-browsers-medium-plus
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2021-11-04 19:44:48 +01:00
- attach_workspace :
at : .
2022-12-01 14:19:14 +01:00
- when :
condition :
not :
matches :
pattern : /^master$/
value : << pipeline.git.branch >>
steps :
- run :
name : build:dist
command : yarn build --build-type flask dist
- when :
condition :
2022-12-08 17:38:04 +01:00
matches :
pattern : /^master$/
value : << pipeline.git.branch >>
2022-12-01 14:19:14 +01:00
steps :
- run :
name : build:prod
command : yarn build --build-type flask prod
2021-11-04 19:44:48 +01:00
- run :
name : build:debug
command : find dist/ -type f -exec md5sum {} \; | sort -k 2
- run :
name : Move flask build to 'dist-flask' to avoid conflict with production build
command : mv ./dist ./dist-flask
- run :
name : Move flask zips to 'builds-flask' to avoid conflict with production build
command : mv ./builds ./builds-flask
- persist_to_workspace :
root : .
paths :
- dist-flask
- builds-flask
2022-03-10 23:01:55 +01:00
prep-build-test-flask :
executor : node-browsers-medium-plus
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2022-03-10 23:01:55 +01:00
- attach_workspace :
at : .
- run :
name : Build extension for testing
command : yarn build:test:flask
- run :
name : Move test build to 'dist-test' to avoid conflict with production build
command : mv ./dist ./dist-test-flask
- run :
name : Move test zips to 'builds-test' to avoid conflict with production build
command : mv ./builds ./builds-test-flask
- persist_to_workspace :
root : .
paths :
- dist-test-flask
- builds-test-flask
2022-07-14 01:34:33 +02:00
prep-build-test-mv3 :
executor : node-browsers-medium-plus
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2022-07-14 01:34:33 +02:00
- attach_workspace :
at : .
- run :
name : Build extension in mv3 for testing
command : yarn build:test:mv3
- run :
name : Move test build to 'dist-test' to avoid conflict with production build
command : mv ./dist ./dist-test-mv3
- run :
name : Move test zips to 'builds-test' to avoid conflict with production build
command : mv ./builds ./builds-test-mv3
- persist_to_workspace :
root : .
paths :
- dist-test-mv3
- builds-test-mv3
2022-03-10 23:01:55 +01:00
2020-01-20 18:03:21 +01:00
prep-build-test :
2020-12-11 18:37:13 +01:00
executor : node-browsers-medium-plus
2020-01-20 18:03:21 +01:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2020-01-20 18:03:21 +01:00
- attach_workspace :
at : .
- run :
name : Build extension for testing
command : yarn build:test
- run :
name : Move test build to 'dist-test' to avoid conflict with production build
command : mv ./dist ./dist-test
2020-12-11 17:24:17 +01:00
- run :
name : Move test zips to 'builds-test' to avoid conflict with production build
command : mv ./builds ./builds-test
2020-01-20 18:03:21 +01:00
- persist_to_workspace :
root : .
paths :
- dist-test
2020-12-11 17:24:17 +01:00
- builds-test
2020-01-20 18:03:21 +01:00
2020-02-08 20:56:33 +01:00
prep-build-storybook :
2023-05-18 04:07:42 +02:00
executor : node-browsers-large
2020-02-08 20:56:33 +01:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2020-02-08 20:56:33 +01:00
- attach_workspace :
at : .
- run :
name : Build Storybook
command : yarn storybook:build
- persist_to_workspace :
root : .
paths :
2021-02-04 15:30:22 +01:00
- storybook-build
2022-03-15 12:24:37 +01:00
Add TypeScript migration dashboard (#13820)
As we convert parts of the codebase to TypeScript, we will want a way to
track progress. This commit adds a dashboard which displays all of the
files that we wish to convert to TypeScript and which files we've
already converted.
The list of all possible files to convert is predetermined by walking
the dependency graph of each entrypoint the build system uses to compile
the extension (the files that the entrypoint imports, the files that the
imports import, etc). The list should not need to be regenerated, but
you can do it by running:
yarn ts-migration:enumerate
The dashboard is implemented as a separate React app. The CircleCI
configuration has been updated so that when a new commit is pushed, the
React app is built and stored in the CircleCI artifacts. When a PR is
merged, the built files will be pushed to a separate repo whose sole
purpose is to serve the dashboard via GitHub Pages (this is the same
way that the Storybook works). All of the app code and script to build
the app are self-contained under
`development/ts-migration-dashboard`. To build this app yourself, you
can run:
yarn ts-migration:dashboard:build
or if you want to build automatically as you change files, run:
yarn ts-migration:dashboard:watch
Then open the following file in your browser (there is no server
component):
development/ts-migration-dashboard/build/index.html
Finally, although you shouldn't have to do this, to manually deploy the
dashboard once built, you can run:
git remote add ts-migration-dashboard git@github.com:MetaMask/metamask-extension-ts-migration-dashboard.git
yarn ts-migration:dashboard:deploy
2022-08-09 22:16:08 +02:00
prep-build-ts-migration-dashboard :
executor : node-browsers
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
Add TypeScript migration dashboard (#13820)
As we convert parts of the codebase to TypeScript, we will want a way to
track progress. This commit adds a dashboard which displays all of the
files that we wish to convert to TypeScript and which files we've
already converted.
The list of all possible files to convert is predetermined by walking
the dependency graph of each entrypoint the build system uses to compile
the extension (the files that the entrypoint imports, the files that the
imports import, etc). The list should not need to be regenerated, but
you can do it by running:
yarn ts-migration:enumerate
The dashboard is implemented as a separate React app. The CircleCI
configuration has been updated so that when a new commit is pushed, the
React app is built and stored in the CircleCI artifacts. When a PR is
merged, the built files will be pushed to a separate repo whose sole
purpose is to serve the dashboard via GitHub Pages (this is the same
way that the Storybook works). All of the app code and script to build
the app are self-contained under
`development/ts-migration-dashboard`. To build this app yourself, you
can run:
yarn ts-migration:dashboard:build
or if you want to build automatically as you change files, run:
yarn ts-migration:dashboard:watch
Then open the following file in your browser (there is no server
component):
development/ts-migration-dashboard/build/index.html
Finally, although you shouldn't have to do this, to manually deploy the
dashboard once built, you can run:
git remote add ts-migration-dashboard git@github.com:MetaMask/metamask-extension-ts-migration-dashboard.git
yarn ts-migration:dashboard:deploy
2022-08-09 22:16:08 +02:00
- attach_workspace :
at : .
- run :
name : Build TypeScript migration dashboard
command : yarn ts-migration:dashboard:build
- persist_to_workspace :
root : .
paths :
2023-02-08 15:33:03 +01:00
- development/ts-migration-dashboard/build/final
Add TypeScript migration dashboard (#13820)
As we convert parts of the codebase to TypeScript, we will want a way to
track progress. This commit adds a dashboard which displays all of the
files that we wish to convert to TypeScript and which files we've
already converted.
The list of all possible files to convert is predetermined by walking
the dependency graph of each entrypoint the build system uses to compile
the extension (the files that the entrypoint imports, the files that the
imports import, etc). The list should not need to be regenerated, but
you can do it by running:
yarn ts-migration:enumerate
The dashboard is implemented as a separate React app. The CircleCI
configuration has been updated so that when a new commit is pushed, the
React app is built and stored in the CircleCI artifacts. When a PR is
merged, the built files will be pushed to a separate repo whose sole
purpose is to serve the dashboard via GitHub Pages (this is the same
way that the Storybook works). All of the app code and script to build
the app are self-contained under
`development/ts-migration-dashboard`. To build this app yourself, you
can run:
yarn ts-migration:dashboard:build
or if you want to build automatically as you change files, run:
yarn ts-migration:dashboard:watch
Then open the following file in your browser (there is no server
component):
development/ts-migration-dashboard/build/index.html
Finally, although you shouldn't have to do this, to manually deploy the
dashboard once built, you can run:
git remote add ts-migration-dashboard git@github.com:MetaMask/metamask-extension-ts-migration-dashboard.git
yarn ts-migration:dashboard:deploy
2022-08-09 22:16:08 +02:00
2021-11-23 20:17:27 +01:00
test-yarn-dedupe :
executor : node-browsers
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2021-11-23 20:17:27 +01:00
- attach_workspace :
at : .
- run :
name : Detect yarn lock deduplications
2022-12-08 17:38:04 +01:00
command : yarn dedupe --check
2021-11-23 20:17:27 +01:00
2018-03-09 22:15:36 +01:00
test-lint :
2020-12-11 18:37:13 +01:00
executor : node-browsers
2018-03-09 21:38:28 +01:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2018-08-17 23:31:39 +02:00
- attach_workspace :
at : .
2018-03-09 21:38:28 +01:00
- run :
2019-09-21 18:31:33 +02:00
name : Lint
Switch from `npm` to `yarn` (#6843)
As a solution to the constant lockfile churn issues we've had with
`npm`, the project now uses `yarn` to manage dependencies.
The `package-lock.json` file has been replaced with `yarn.lock`, which
was created using `yarn import`. It should approximate the contents of
`package-lock.json` fairly well, though there may be some changes due to
deduplication. The codeowners file has been updated to reference this
new lockfile.
All documentation and npm scripts have been updated to reference `yarn`
rather than `npm`. Note that running scripts using `npm run` still works
fine, but it seemed better to switch those to `yarn` as well to avoid
confusion.
The `npm-audit` Bash script has been replaced with `yarn-audit`. The
output of `yarn audit` is a bit different than `npm audit` in that it
returns a bitmask to describe which severity issues were found. This
made it simpler to check the results directly from the Bash script, so
the associated `npm-audit-check.js` script was no longer required. The
output should be exactly the same, and the information is still sourced
from the same place (the npm registry).
The new `yarn-audit` script does have an external dependency: `jq`.
However, `jq` is already assumed to be present by another CI script, and
is present on all CI images we use. `jq` was not added to `package.json`
as a dependency because there is no official package on the npm
registry, just wrapper scripts. We don't need it anywhere exept on CI
anyway.
The section in `CONTRIBUTING` about how to develop inside the
`node_modules` folder was removed, as the advice was a bit dated, and
wasn't specific to this project anyway.
2019-07-30 20:36:23 +02:00
command : yarn lint
2019-09-21 18:31:33 +02:00
- run :
name : Verify locales
command : yarn verify-locales --quiet
2018-03-09 22:37:13 +01:00
2023-01-20 20:27:46 +01:00
test-storybook :
2023-05-18 04:07:42 +02:00
executor : node-browsers-large
2023-01-20 20:27:46 +01:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2023-01-20 20:27:46 +01:00
- attach_workspace :
at : .
- run :
name : Install Playwright browsers
2023-01-25 18:52:04 +01:00
command : yarn exec playwright install
2023-01-20 20:27:46 +01:00
- run :
name : Test Storybook
command : yarn test-storybook:ci
2019-11-19 16:46:10 +01:00
test-lint-shellcheck :
2020-12-11 18:37:13 +01:00
executor : shellcheck
2019-11-19 16:46:10 +01:00
steps :
- checkout
2020-01-30 14:59:16 +01:00
- run : apk add --no-cache bash jq yarn
2019-11-19 16:46:10 +01:00
- run :
2020-09-21 22:08:15 +02:00
name : ShellCheck Lint
command : ./development/shellcheck.sh
2019-11-19 16:46:10 +01:00
2020-01-06 19:58:43 +01:00
test-lint-lockfile :
2020-12-11 18:37:13 +01:00
executor : node-browsers
2020-01-06 19:58:43 +01:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2020-01-06 19:58:43 +01:00
- attach_workspace :
at : .
- run :
name : lockfile-lint
command : yarn lint:lockfile
2021-05-06 20:55:50 +02:00
test-lint-changelog :
executor : node-browsers
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2021-05-06 20:55:50 +02:00
- attach_workspace :
at : .
- when :
condition :
not :
matches :
pattern : /^Version-v(\d+)[.](\d+)[.](\d+)$/
value : << pipeline.git.branch >>
steps :
- run :
name : Validate changelog
2021-08-18 17:59:48 +02:00
command : yarn lint:changelog
2021-05-06 20:55:50 +02:00
- when :
condition :
matches :
pattern : /^Version-v(\d+)[.](\d+)[.](\d+)$/
value : << pipeline.git.branch >>
steps :
- run :
name : Validate release candidate changelog
2023-03-04 13:51:04 +01:00
command : .circleci/scripts/validate-changelog-in-rc.sh
2021-05-06 20:55:50 +02:00
2021-07-28 05:03:03 +02:00
test-deps-audit :
2020-12-11 18:37:13 +01:00
executor : node-browsers
2019-06-06 17:56:27 +02:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2019-06-06 17:56:27 +02:00
- attach_workspace :
at : .
2019-07-25 00:54:16 +02:00
- run :
Switch from `npm` to `yarn` (#6843)
As a solution to the constant lockfile churn issues we've had with
`npm`, the project now uses `yarn` to manage dependencies.
The `package-lock.json` file has been replaced with `yarn.lock`, which
was created using `yarn import`. It should approximate the contents of
`package-lock.json` fairly well, though there may be some changes due to
deduplication. The codeowners file has been updated to reference this
new lockfile.
All documentation and npm scripts have been updated to reference `yarn`
rather than `npm`. Note that running scripts using `npm run` still works
fine, but it seemed better to switch those to `yarn` as well to avoid
confusion.
The `npm-audit` Bash script has been replaced with `yarn-audit`. The
output of `yarn audit` is a bit different than `npm audit` in that it
returns a bitmask to describe which severity issues were found. This
made it simpler to check the results directly from the Bash script, so
the associated `npm-audit-check.js` script was no longer required. The
output should be exactly the same, and the information is still sourced
from the same place (the npm registry).
The new `yarn-audit` script does have an external dependency: `jq`.
However, `jq` is already assumed to be present by another CI script, and
is present on all CI images we use. `jq` was not added to `package.json`
as a dependency because there is no official package on the npm
registry, just wrapper scripts. We don't need it anywhere exept on CI
anyway.
The section in `CONTRIBUTING` about how to develop inside the
`node_modules` folder was removed, as the advice was a bit dated, and
wasn't specific to this project anyway.
2019-07-30 20:36:23 +02:00
name : yarn audit
2021-02-23 17:26:41 +01:00
command : .circleci/scripts/yarn-audit.sh
2018-05-02 20:05:39 +02:00
2021-07-28 05:03:03 +02:00
test-deps-depcheck :
executor : node-browsers
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2021-07-28 05:03:03 +02:00
- attach_workspace :
at : .
- run :
name : depcheck
command : yarn depcheck
2019-02-20 14:57:49 +01:00
test-e2e-chrome :
2020-12-11 18:37:13 +01:00
executor : node-browsers
2022-11-08 18:28:06 +01:00
parallelism : 8
2018-05-28 18:22:48 +02:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2021-02-03 06:45:38 +01:00
- run :
name : Re-Install Chrome
command : ./.circleci/scripts/chrome-install.sh
2018-08-17 23:31:39 +02:00
- attach_workspace :
at : .
2020-01-20 18:03:21 +01:00
- run :
name : Move test build to dist
command : mv ./dist-test ./dist
2020-12-11 17:24:17 +01:00
- run :
name : Move test zips to builds
command : mv ./builds-test ./builds
2018-05-28 18:22:48 +02:00
- run :
2019-02-20 14:57:49 +01:00
name : test:e2e:chrome
2020-10-07 19:42:52 +02:00
command : |
2021-02-23 17:26:41 +01:00
if .circleci/scripts/test-run-e2e.sh
2020-10-07 19:42:52 +02:00
then
2023-06-15 19:18:15 +02:00
yarn test:e2e:chrome --retries 2 --debug
2020-10-07 19:42:52 +02:00
fi
2019-03-28 17:43:11 +01:00
no_output_timeout : 20m
2023-02-08 15:34:44 +01:00
- run :
name : Merge JUnit report
command : |
if [ "$(ls -A test/test-results/e2e)" ]; then
yarn test:e2e:report
fi
2023-02-22 15:40:55 +01:00
when : always
2018-05-28 18:22:48 +02:00
- store_artifacts :
path : test-artifacts
destination : test-artifacts
2023-02-08 15:34:44 +01:00
- store_test_results :
path : test/test-results/e2e.xml
2022-11-09 16:02:44 +01:00
2022-10-10 14:33:13 +02:00
test-e2e-chrome-mv3 :
executor : node-browsers
2022-11-08 18:28:06 +01:00
parallelism : 8
2022-10-10 14:33:13 +02:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2022-10-10 14:33:13 +02:00
- run :
name : Re-Install Chrome
command : ./.circleci/scripts/chrome-install.sh
- attach_workspace :
at : .
- run :
name : Move test build to dist
command : mv ./dist-test-mv3 ./dist
- run :
name : Move test zips to builds
command : mv ./builds-test-mv3 ./builds
- run :
name : test:e2e:chrome
command : |
if .circleci/scripts/test-run-e2e.sh
then
2023-06-15 19:18:15 +02:00
yarn test:e2e:chrome --retries 2 --debug --mv3 || echo "Temporarily suppressing MV3 e2e test failures"
2022-10-10 14:33:13 +02:00
fi
no_output_timeout : 20m
- store_artifacts :
path : test-artifacts
destination : test-artifacts
2018-05-28 18:22:48 +02:00
2022-03-10 23:01:55 +01:00
test-e2e-firefox-snaps :
executor : node-browsers
2023-04-06 16:57:11 +02:00
parallelism : 4
2022-03-10 23:01:55 +01:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2022-03-10 23:01:55 +01:00
- run :
name : Install Firefox
command : ./.circleci/scripts/firefox-install.sh
- attach_workspace :
at : .
- run :
name : Move test build to dist
command : mv ./dist-test-flask ./dist
- run :
name : Move test zips to builds
command : mv ./builds-test-flask ./builds
- run :
name : test:e2e:firefox:snaps
command : |
if .circleci/scripts/test-run-e2e.sh
then
2023-06-15 19:18:15 +02:00
yarn test:e2e:firefox:snaps --retries 2 --debug
2022-03-10 23:01:55 +01:00
fi
no_output_timeout : 20m
2023-02-08 15:34:44 +01:00
- run :
name : Merge JUnit report
command : |
if [ "$(ls -A test/test-results/e2e)" ]; then
yarn test:e2e:report
fi
2023-02-22 15:40:55 +01:00
when : always
2022-03-10 23:01:55 +01:00
- store_artifacts :
path : test-artifacts
destination : test-artifacts
2023-02-08 15:34:44 +01:00
- store_test_results :
path : test/test-results/e2e.xml
2022-03-10 23:01:55 +01:00
test-e2e-chrome-snaps :
executor : node-browsers
2023-04-06 16:57:11 +02:00
parallelism : 4
2022-03-10 23:01:55 +01:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2022-03-10 23:01:55 +01:00
- run :
name : Re-Install Chrome
command : ./.circleci/scripts/chrome-install.sh
- attach_workspace :
at : .
- run :
name : Move test build to dist
command : mv ./dist-test-flask ./dist
- run :
name : Move test zips to builds
command : mv ./builds-test-flask ./builds
- run :
name : test:e2e:chrome:snaps
command : |
if .circleci/scripts/test-run-e2e.sh
then
2023-06-15 19:18:15 +02:00
yarn test:e2e:chrome:snaps --retries 2 --debug
2022-03-10 23:01:55 +01:00
fi
no_output_timeout : 20m
2023-02-08 15:34:44 +01:00
- run :
name : Merge JUnit report
command : |
if [ "$(ls -A test/test-results/e2e)" ]; then
yarn test:e2e:report
fi
2023-02-22 15:40:55 +01:00
when : always
2022-03-10 23:01:55 +01:00
- store_artifacts :
path : test-artifacts
destination : test-artifacts
2023-02-08 15:34:44 +01:00
- store_test_results :
path : test/test-results/e2e.xml
2022-03-10 23:01:55 +01:00
2019-02-20 14:57:49 +01:00
test-e2e-firefox :
2021-09-28 00:39:31 +02:00
executor : node-browsers-medium-plus
2022-11-08 18:28:06 +01:00
parallelism : 8
2018-05-28 18:22:48 +02:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2018-05-28 18:22:48 +02:00
- run :
2018-08-17 15:43:47 +02:00
name : Install Firefox
2021-02-23 17:26:41 +01:00
command : ./.circleci/scripts/firefox-install.sh
2018-08-17 23:31:39 +02:00
- attach_workspace :
at : .
2020-01-20 18:03:21 +01:00
- run :
name : Move test build to dist
command : mv ./dist-test ./dist
2020-12-11 17:24:17 +01:00
- run :
name : Move test zips to builds
command : mv ./builds-test ./builds
2018-05-28 18:22:48 +02:00
- run :
2019-02-20 14:57:49 +01:00
name : test:e2e:firefox
2020-10-07 19:42:52 +02:00
command : |
2021-02-23 17:26:41 +01:00
if .circleci/scripts/test-run-e2e.sh
2020-10-07 19:42:52 +02:00
then
2023-06-15 19:18:15 +02:00
yarn test:e2e:firefox --retries 2 --debug
2020-10-07 19:42:52 +02:00
fi
2019-03-28 17:43:11 +01:00
no_output_timeout : 20m
2023-02-08 15:34:44 +01:00
- run :
name : Merge JUnit report
command : |
if [ "$(ls -A test/test-results/e2e)" ]; then
yarn test:e2e:report
fi
2023-02-22 15:40:55 +01:00
when : always
2018-05-28 18:22:48 +02:00
- store_artifacts :
path : test-artifacts
destination : test-artifacts
2023-02-08 15:34:44 +01:00
- store_test_results :
path : test/test-results/e2e.xml
2018-05-28 18:22:48 +02:00
2020-01-23 21:55:17 +01:00
benchmark :
2021-02-04 14:13:00 +01:00
executor : node-browsers-medium-plus
2020-01-23 21:55:17 +01:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2021-02-03 06:45:38 +01:00
- run :
name : Re-Install Chrome
command : ./.circleci/scripts/chrome-install.sh
2020-01-23 21:55:17 +01:00
- attach_workspace :
at : .
- run :
name : Move test build to dist
command : mv ./dist-test ./dist
2020-12-11 17:24:17 +01:00
- run :
name : Move test zips to builds
command : mv ./builds-test ./builds
2020-01-23 21:55:17 +01:00
- run :
name : Run page load benchmark
2021-06-21 17:16:18 +02:00
command : yarn benchmark:chrome --out test-artifacts/chrome/benchmark/pageload.json --retries 2
2020-01-23 21:55:17 +01:00
- store_artifacts :
path : test-artifacts
destination : test-artifacts
- persist_to_workspace :
root : .
paths :
- test-artifacts
2022-10-07 17:38:38 +02:00
2022-08-12 19:41:20 +02:00
user-actions-benchmark :
executor : node-browsers-medium-plus
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2022-08-12 19:41:20 +02:00
- run :
name : Re-Install Chrome
command : ./.circleci/scripts/chrome-install.sh
- attach_workspace :
at : .
- run :
name : Move test build to dist
command : mv ./dist-test ./dist
- run :
name : Move test zips to builds
command : mv ./builds-test ./builds
- run :
name : Run page load benchmark
command : yarn user-actions-benchmark:chrome --out test-artifacts/chrome/benchmark/user_actions.json --retries 2
- store_artifacts :
path : test-artifacts
destination : test-artifacts
- persist_to_workspace :
root : .
paths :
- test-artifacts
2020-01-23 21:55:17 +01:00
2022-07-20 17:33:16 +02:00
stats-module-load-init :
executor : node-browsers-medium-plus
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2022-07-20 17:33:16 +02:00
- run :
name : Re-Install Chrome
command : ./.circleci/scripts/chrome-install.sh
- attach_workspace :
at : .
- run :
name : Move test build to dist
command : mv ./dist-test-mv3 ./dist
- run :
name : Move test zips to builds
command : mv ./builds-test-mv3 ./builds
- run :
name : Run page load benchmark
command : |
mkdir -p test-artifacts/chrome/mv3
cp -R development/charts/flamegraph test-artifacts/chrome/mv3/initialisation
cp -R development/charts/flamegraph/chart test-artifacts/chrome/mv3/initialisation/background
cp -R development/charts/flamegraph/chart test-artifacts/chrome/mv3/initialisation/ui
cp -R development/charts/table test-artifacts/chrome/mv3/load_time
- run :
name : Run page load benchmark
command : yarn mv3:stats:chrome --out test-artifacts/chrome/mv3
2022-10-13 11:59:22 +02:00
- run :
name : Install jq
command : sudo apt install jq -y
2022-07-22 00:25:18 +02:00
- run :
name : Record bundle size at commit
command : ./.circleci/scripts/bundle-stats-commit.sh
2022-07-20 17:33:16 +02:00
- store_artifacts :
path : test-artifacts
destination : test-artifacts
- persist_to_workspace :
root : .
paths :
- test-artifacts
2018-05-18 20:10:42 +02:00
job-publish-prerelease :
2020-12-11 18:37:13 +01:00
executor : node-browsers
2018-03-31 02:59:15 +02:00
steps :
- checkout
2018-08-17 23:31:39 +02:00
- attach_workspace :
at : .
2019-09-11 17:35:30 +02:00
- run :
name : build:source-map-explorer
command : ./development/source-map-explorer.sh
2018-04-03 20:11:00 +02:00
- store_artifacts :
path : dist/sourcemaps
destination : builds/sourcemaps
2021-11-04 19:44:48 +01:00
- store_artifacts :
path : dist-beta/sourcemaps
destination : builds-beta/sourcemaps
- store_artifacts :
path : dist-flask/sourcemaps
destination : builds-flask/sourcemaps
2018-03-31 02:59:15 +02:00
- store_artifacts :
path : builds
destination : builds
2021-11-04 19:44:48 +01:00
- store_artifacts :
path : builds-beta
destination : builds-beta
- store_artifacts :
path : builds-flask
destination : builds-flask
2020-12-11 20:51:00 +01:00
- store_artifacts :
path : coverage
destination : coverage
2018-03-30 10:01:16 +02:00
- store_artifacts :
path : test-artifacts
destination : test-artifacts
2021-02-22 15:43:29 +01:00
# important: generate lavamoat viz AFTER uploading builds as artifacts
# Temporarily disabled until we can update to a version of `sesify` with
# this fix included: https://github.com/LavaMoat/LavaMoat/pull/121
- run :
name : build:lavamoat-viz
2021-02-23 17:26:41 +01:00
command : ./.circleci/scripts/create-lavamoat-viz.sh
2019-09-11 16:47:21 +02:00
- store_artifacts :
path : build-artifacts
destination : build-artifacts
2021-02-04 15:30:22 +01:00
- store_artifacts :
path : storybook-build
destination : storybook
Add TypeScript migration dashboard (#13820)
As we convert parts of the codebase to TypeScript, we will want a way to
track progress. This commit adds a dashboard which displays all of the
files that we wish to convert to TypeScript and which files we've
already converted.
The list of all possible files to convert is predetermined by walking
the dependency graph of each entrypoint the build system uses to compile
the extension (the files that the entrypoint imports, the files that the
imports import, etc). The list should not need to be regenerated, but
you can do it by running:
yarn ts-migration:enumerate
The dashboard is implemented as a separate React app. The CircleCI
configuration has been updated so that when a new commit is pushed, the
React app is built and stored in the CircleCI artifacts. When a PR is
merged, the built files will be pushed to a separate repo whose sole
purpose is to serve the dashboard via GitHub Pages (this is the same
way that the Storybook works). All of the app code and script to build
the app are self-contained under
`development/ts-migration-dashboard`. To build this app yourself, you
can run:
yarn ts-migration:dashboard:build
or if you want to build automatically as you change files, run:
yarn ts-migration:dashboard:watch
Then open the following file in your browser (there is no server
component):
development/ts-migration-dashboard/build/index.html
Finally, although you shouldn't have to do this, to manually deploy the
dashboard once built, you can run:
git remote add ts-migration-dashboard git@github.com:MetaMask/metamask-extension-ts-migration-dashboard.git
yarn ts-migration:dashboard:deploy
2022-08-09 22:16:08 +02:00
- store_artifacts :
2023-02-08 15:33:03 +01:00
path : development/ts-migration-dashboard/build/final
Add TypeScript migration dashboard (#13820)
As we convert parts of the codebase to TypeScript, we will want a way to
track progress. This commit adds a dashboard which displays all of the
files that we wish to convert to TypeScript and which files we've
already converted.
The list of all possible files to convert is predetermined by walking
the dependency graph of each entrypoint the build system uses to compile
the extension (the files that the entrypoint imports, the files that the
imports import, etc). The list should not need to be regenerated, but
you can do it by running:
yarn ts-migration:enumerate
The dashboard is implemented as a separate React app. The CircleCI
configuration has been updated so that when a new commit is pushed, the
React app is built and stored in the CircleCI artifacts. When a PR is
merged, the built files will be pushed to a separate repo whose sole
purpose is to serve the dashboard via GitHub Pages (this is the same
way that the Storybook works). All of the app code and script to build
the app are self-contained under
`development/ts-migration-dashboard`. To build this app yourself, you
can run:
yarn ts-migration:dashboard:build
or if you want to build automatically as you change files, run:
yarn ts-migration:dashboard:watch
Then open the following file in your browser (there is no server
component):
development/ts-migration-dashboard/build/index.html
Finally, although you shouldn't have to do this, to manually deploy the
dashboard once built, you can run:
git remote add ts-migration-dashboard git@github.com:MetaMask/metamask-extension-ts-migration-dashboard.git
yarn ts-migration:dashboard:deploy
2022-08-09 22:16:08 +02:00
destination : ts-migration-dashboard
2022-11-09 16:02:44 +01:00
- run :
name : Set branch parent commit env var
command : |
2022-11-23 18:05:57 +01:00
echo "export PARENT_COMMIT=$(git merge-base origin/HEAD HEAD)" >> $BASH_ENV
2022-11-09 16:02:44 +01:00
source $BASH_ENV
2018-03-31 02:59:15 +02:00
- run :
name : build:announce
command : ./development/metamaskbot-build-announce.js
2018-05-18 20:29:10 +02:00
job-publish-release :
2020-12-11 18:37:13 +01:00
executor : node-browsers
2018-05-18 20:29:10 +02:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2018-08-17 23:31:39 +02:00
- attach_workspace :
at : .
2018-04-03 21:36:46 +02:00
- run :
2022-03-15 12:24:37 +01:00
name : Publish main release to Sentry
command : yarn sentry:publish
- run :
name : Publish Flask release to Sentry
command : yarn sentry:publish --build-type flask
2019-09-11 16:44:36 +02:00
- run :
name : Create GitHub release
command : |
2021-02-23 17:26:41 +01:00
.circleci/scripts/release-create-gh-release.sh
2020-02-08 20:56:33 +01:00
job-publish-storybook :
2020-12-11 18:37:13 +01:00
executor : node-browsers
2020-02-08 20:56:33 +01:00
steps :
- add_ssh_keys :
fingerprints :
2022-07-14 01:34:33 +02:00
- '3d:49:29:f4:b2:e8:ea:af:d1:32:eb:2a:fc:15:85:d8'
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2020-02-08 20:56:33 +01:00
- attach_workspace :
at : .
- run :
name : storybook:deploy
command : |
git remote add storybook git@github.com:MetaMask/metamask-storybook.git
yarn storybook:deploy
2018-03-30 10:01:16 +02:00
Add TypeScript migration dashboard (#13820)
As we convert parts of the codebase to TypeScript, we will want a way to
track progress. This commit adds a dashboard which displays all of the
files that we wish to convert to TypeScript and which files we've
already converted.
The list of all possible files to convert is predetermined by walking
the dependency graph of each entrypoint the build system uses to compile
the extension (the files that the entrypoint imports, the files that the
imports import, etc). The list should not need to be regenerated, but
you can do it by running:
yarn ts-migration:enumerate
The dashboard is implemented as a separate React app. The CircleCI
configuration has been updated so that when a new commit is pushed, the
React app is built and stored in the CircleCI artifacts. When a PR is
merged, the built files will be pushed to a separate repo whose sole
purpose is to serve the dashboard via GitHub Pages (this is the same
way that the Storybook works). All of the app code and script to build
the app are self-contained under
`development/ts-migration-dashboard`. To build this app yourself, you
can run:
yarn ts-migration:dashboard:build
or if you want to build automatically as you change files, run:
yarn ts-migration:dashboard:watch
Then open the following file in your browser (there is no server
component):
development/ts-migration-dashboard/build/index.html
Finally, although you shouldn't have to do this, to manually deploy the
dashboard once built, you can run:
git remote add ts-migration-dashboard git@github.com:MetaMask/metamask-extension-ts-migration-dashboard.git
yarn ts-migration:dashboard:deploy
2022-08-09 22:16:08 +02:00
job-publish-ts-migration-dashboard :
executor : node-browsers
steps :
- add_ssh_keys :
fingerprints :
2022-12-08 17:38:04 +01:00
- '8b:21:e3:20:7c:c9:db:82:74:2d:86:d6:11:a7:2f:49'
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
Add TypeScript migration dashboard (#13820)
As we convert parts of the codebase to TypeScript, we will want a way to
track progress. This commit adds a dashboard which displays all of the
files that we wish to convert to TypeScript and which files we've
already converted.
The list of all possible files to convert is predetermined by walking
the dependency graph of each entrypoint the build system uses to compile
the extension (the files that the entrypoint imports, the files that the
imports import, etc). The list should not need to be regenerated, but
you can do it by running:
yarn ts-migration:enumerate
The dashboard is implemented as a separate React app. The CircleCI
configuration has been updated so that when a new commit is pushed, the
React app is built and stored in the CircleCI artifacts. When a PR is
merged, the built files will be pushed to a separate repo whose sole
purpose is to serve the dashboard via GitHub Pages (this is the same
way that the Storybook works). All of the app code and script to build
the app are self-contained under
`development/ts-migration-dashboard`. To build this app yourself, you
can run:
yarn ts-migration:dashboard:build
or if you want to build automatically as you change files, run:
yarn ts-migration:dashboard:watch
Then open the following file in your browser (there is no server
component):
development/ts-migration-dashboard/build/index.html
Finally, although you shouldn't have to do this, to manually deploy the
dashboard once built, you can run:
git remote add ts-migration-dashboard git@github.com:MetaMask/metamask-extension-ts-migration-dashboard.git
yarn ts-migration:dashboard:deploy
2022-08-09 22:16:08 +02:00
- attach_workspace :
at : .
- run :
name : ts-migration-dashboard:deploy
command : |
git remote add ts-migration-dashboard git@github.com:MetaMask/metamask-extension-ts-migration-dashboard.git
2022-08-10 17:45:21 +02:00
git config user.name "MetaMask Bot"
git config user.email metamaskbot@users.noreply.github.com
Add TypeScript migration dashboard (#13820)
As we convert parts of the codebase to TypeScript, we will want a way to
track progress. This commit adds a dashboard which displays all of the
files that we wish to convert to TypeScript and which files we've
already converted.
The list of all possible files to convert is predetermined by walking
the dependency graph of each entrypoint the build system uses to compile
the extension (the files that the entrypoint imports, the files that the
imports import, etc). The list should not need to be regenerated, but
you can do it by running:
yarn ts-migration:enumerate
The dashboard is implemented as a separate React app. The CircleCI
configuration has been updated so that when a new commit is pushed, the
React app is built and stored in the CircleCI artifacts. When a PR is
merged, the built files will be pushed to a separate repo whose sole
purpose is to serve the dashboard via GitHub Pages (this is the same
way that the Storybook works). All of the app code and script to build
the app are self-contained under
`development/ts-migration-dashboard`. To build this app yourself, you
can run:
yarn ts-migration:dashboard:build
or if you want to build automatically as you change files, run:
yarn ts-migration:dashboard:watch
Then open the following file in your browser (there is no server
component):
development/ts-migration-dashboard/build/index.html
Finally, although you shouldn't have to do this, to manually deploy the
dashboard once built, you can run:
git remote add ts-migration-dashboard git@github.com:MetaMask/metamask-extension-ts-migration-dashboard.git
yarn ts-migration:dashboard:deploy
2022-08-09 22:16:08 +02:00
yarn ts-migration:dashboard:deploy
2023-01-11 19:23:38 +01:00
test-unit-mocha :
executor : node-browsers-medium-plus
2018-03-09 22:15:36 +01:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2018-08-17 23:31:39 +02:00
- attach_workspace :
at : .
2018-03-09 22:15:36 +01:00
- run :
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
name : test:coverage:mocha
command : yarn test:coverage:mocha
2023-01-11 19:23:38 +01:00
- persist_to_workspace :
root : .
paths :
- .nyc_output
- coverage
test-unit-jest-development :
executor : node-browsers
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2023-01-11 19:23:38 +01:00
- attach_workspace :
at : .
- run :
name : jest development unit tests
command : yarn test:coverage:jest:dev
- persist_to_workspace :
root : .
paths :
- coverage
- store_test_results :
path : test/test-results/junit.xml
test-unit-jest-main :
executor : node-browsers-medium-plus
parallelism : 12
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2023-01-11 19:23:38 +01:00
- attach_workspace :
at : .
2021-04-09 19:20:32 +02:00
- run :
name : test:coverage:jest
command : yarn test:coverage:jest
2019-08-14 15:11:01 +02:00
- persist_to_workspace :
root : .
paths :
- coverage
2022-09-19 13:30:34 +02:00
- store_test_results :
path : test/test-results/junit.xml
2023-01-11 19:23:38 +01:00
upload-and-validate-coverage :
executor : node-browsers
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2023-01-11 19:23:38 +01:00
- attach_workspace :
at : .
- codecov/upload
- run :
name : test:coverage:validate
command : yarn test:coverage:validate
- persist_to_workspace :
root : .
paths :
- coverage
2019-10-24 15:54:32 +02:00
test-unit-global :
2020-12-11 18:37:13 +01:00
executor : node-browsers
2019-10-24 15:54:32 +02:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2019-10-24 15:54:32 +02:00
- attach_workspace :
at : .
- run :
name : test:unit:global
command : yarn test:unit:global
2020-08-04 19:21:46 +02:00
validate-source-maps :
2020-12-11 18:37:13 +01:00
executor : node-browsers
2020-08-04 19:21:46 +02:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2020-08-04 19:21:46 +02:00
- attach_workspace :
at : .
- run :
name : Validate source maps
command : yarn validate-source-maps
2021-11-04 19:44:48 +01:00
validate-source-maps-beta :
executor : node-browsers
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2021-11-04 19:44:48 +01:00
- attach_workspace :
at : .
- run :
name : Validate source maps
2023-03-04 13:51:04 +01:00
command : |
.circleci/scripts/validate-source-maps-beta.sh
2021-11-04 19:44:48 +01:00
2023-02-08 10:24:01 +01:00
validate-source-maps-desktop :
executor : node-browsers
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2023-02-08 10:24:01 +01:00
- attach_workspace :
at : .
- run :
name : Move desktop build to dist
command : mv ./dist-desktop ./dist
- run :
name : Move desktop zips to builds
command : mv ./builds-desktop ./builds
- run :
name : Validate source maps
command : yarn validate-source-maps
2021-11-04 19:44:48 +01:00
validate-source-maps-flask :
executor : node-browsers
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2021-11-04 19:44:48 +01:00
- attach_workspace :
at : .
- run :
name : Move flask build to dist
command : mv ./dist-flask ./dist
- run :
name : Move flask zips to builds
command : mv ./builds-flask ./builds
- run :
name : Validate source maps
command : yarn validate-source-maps
2018-09-26 02:44:57 +02:00
test-mozilla-lint :
2020-12-11 18:37:13 +01:00
executor : node-browsers
2018-09-26 02:44:57 +02:00
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2018-09-26 02:44:57 +02:00
- attach_workspace :
at : .
- run :
name : test:mozilla-lint
Switch from `npm` to `yarn` (#6843)
As a solution to the constant lockfile churn issues we've had with
`npm`, the project now uses `yarn` to manage dependencies.
The `package-lock.json` file has been replaced with `yarn.lock`, which
was created using `yarn import`. It should approximate the contents of
`package-lock.json` fairly well, though there may be some changes due to
deduplication. The codeowners file has been updated to reference this
new lockfile.
All documentation and npm scripts have been updated to reference `yarn`
rather than `npm`. Note that running scripts using `npm run` still works
fine, but it seemed better to switch those to `yarn` as well to avoid
confusion.
The `npm-audit` Bash script has been replaced with `yarn-audit`. The
output of `yarn audit` is a bit different than `npm audit` in that it
returns a bitmask to describe which severity issues were found. This
made it simpler to check the results directly from the Bash script, so
the associated `npm-audit-check.js` script was no longer required. The
output should be exactly the same, and the information is still sourced
from the same place (the npm registry).
The new `yarn-audit` script does have an external dependency: `jq`.
However, `jq` is already assumed to be present by another CI script, and
is present on all CI images we use. `jq` was not added to `package.json`
as a dependency because there is no official package on the npm
registry, just wrapper scripts. We don't need it anywhere exept on CI
anyway.
The section in `CONTRIBUTING` about how to develop inside the
`node_modules` folder was removed, as the advice was a bit dated, and
wasn't specific to this project anyway.
2019-07-30 20:36:23 +02:00
command : NODE_OPTIONS=--max_old_space_size=3072 yarn mozilla-lint
2018-03-09 22:37:13 +01:00
2023-02-08 10:24:01 +01:00
test-mozilla-lint-desktop :
executor : node-browsers
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2023-02-08 10:24:01 +01:00
- attach_workspace :
at : .
- run :
name : Move desktop build to dist
command : mv ./dist-desktop ./dist
- run :
name : Move desktop zips to builds
command : mv ./builds-desktop ./builds
- run :
name : test:mozilla-lint
command : NODE_OPTIONS=--max_old_space_size=3072 yarn mozilla-lint
2021-11-04 19:44:48 +01:00
test-mozilla-lint-flask :
executor : node-browsers
steps :
2023-06-27 19:57:46 +02:00
- run : *shallow-git-clone
2021-11-04 19:44:48 +01:00
- attach_workspace :
at : .
- run :
name : Move flask build to dist
command : mv ./dist-flask ./dist
- run :
name : Move flask zips to builds
command : mv ./builds-flask ./builds
- run :
name : test:mozilla-lint
command : NODE_OPTIONS=--max_old_space_size=3072 yarn mozilla-lint
2018-03-28 01:09:11 +02:00
all-tests-pass :
2020-12-11 18:37:13 +01:00
executor : node-browsers
2018-03-28 01:09:11 +02:00
steps :
- run :
2018-03-28 01:10:27 +02:00
name : All Tests Passed
2018-08-17 15:43:47 +02:00
command : echo 'weew - everything passed!'
