2021-04-09 19:20:32 +02:00
|
|
|
module.exports = {
|
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
|
|
|
collectCoverageFrom: [
|
2023-01-11 19:23:38 +01:00
|
|
|
'<rootDir>/app/scripts/constants/error-utils.js',
|
2022-02-15 01:02:51 +01:00
|
|
|
'<rootDir>/app/scripts/controllers/permissions/**/*.js',
|
2023-03-20 14:19:50 +01:00
|
|
|
'<rootDir>/app/scripts/controllers/sign.ts',
|
2023-04-26 17:02:33 +02:00
|
|
|
'<rootDir>/app/scripts/controllers/decrypt-message.ts',
|
2023-08-22 11:17:07 +02:00
|
|
|
'<rootDir>/app/scripts/controllers/transactions/etherscan.ts',
|
|
|
|
|
'<rootDir>/app/scripts/controllers/transactions/EtherscanRemoteTransactionSource.ts',
|
|
|
|
|
'<rootDir>/app/scripts/controllers/transactions/IncomingTransactionHelper.ts',
|
2023-08-24 12:27:42 +02:00
|
|
|
'<rootDir>/app/scripts/controllers/preferences.js',
|
2023-01-11 19:23:38 +01:00
|
|
|
'<rootDir>/app/scripts/flask/**/*.js',
|
2023-08-23 07:13:13 +02:00
|
|
|
'<rootDir>/app/scripts/lib/**/*.(js|ts)',
|
2022-07-20 15:25:04 +02:00
|
|
|
'<rootDir>/app/scripts/lib/createRPCMethodTrackingMiddleware.js',
|
2023-01-11 19:23:38 +01:00
|
|
|
'<rootDir>/app/scripts/migrations/*.js',
|
2023-06-09 22:48:48 +02:00
|
|
|
'<rootDir>/app/scripts/migrations/*.ts',
|
|
|
|
|
'!<rootDir>/app/scripts/migrations/*.test.(js|ts)',
|
2023-01-11 19:23:38 +01:00
|
|
|
'<rootDir>/app/scripts/platforms/*.js',
|
2023-02-01 17:51:12 +01:00
|
|
|
'<rootDir>/shared/**/*.(js|ts|tsx)',
|
|
|
|
|
'<rootDir>/ui/**/*.(js|ts|tsx)',
|
2023-02-09 18:08:48 +01:00
|
|
|
'<rootDir>/development/fitness-functions/**/*.test.(js|ts|tsx)',
|
2023-07-28 20:57:06 +02:00
|
|
|
'<rootDir>/test/e2e/helpers.test.js',
|
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
|
|
|
],
|
2023-01-11 19:23:38 +01:00
|
|
|
coverageDirectory: './coverage',
|
2023-03-21 00:24:26 +01:00
|
|
|
coveragePathIgnorePatterns: ['.stories.*', '.snap'],
|
2023-04-20 20:33:25 +02:00
|
|
|
coverageReporters: ['html', 'json'],
|
2022-09-19 13:30:34 +02:00
|
|
|
reporters: [
|
|
|
|
|
'default',
|
|
|
|
|
[
|
|
|
|
|
'jest-junit',
|
|
|
|
|
{
|
|
|
|
|
outputDirectory: 'test/test-results/',
|
|
|
|
|
outputName: 'junit.xml',
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
],
|
Add build-time code exclusion using code fencing (#12060)
This PR adds build-time code exclusion by means of code fencing. For details, please see the README in `./development/build/transforms`. Note that linting of transformed files as a form of validation is added in a follow-up, #12075.
Hopefully exhaustive tests are added to ensure that the transform works according to its specification. Since these tests are Node-only, they required their own Jest config. The recommended way to work with multiple Jest configs is using the `projects` field in the Jest config, however [that feature breaks coverage collection](https://github.com/facebook/jest/issues/9628). That being the case, I had to set up two separate Jest configs. In order to get both test suites to run in parallel, Jest is now invoked via a script, `./test/run-jest.sh`.
By way of example, this build system feature allows us to add fences like this:
```javascript
this.store.updateStructure({
...,
GasFeeController: this.gasFeeController,
TokenListController: this.tokenListController,
///: BEGIN:ONLY_INCLUDE_IN(beta)
PluginController: this.pluginController,
///: END:ONLY_INCLUDE_IN
});
```
Which at build time are transformed to the following if the build type is not `beta`:
```javascript
this.store.updateStructure({
...,
GasFeeController: this.gasFeeController,
TokenListController: this.tokenListController,
});
```
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-09-14 19:00:04 +02:00
|
|
|
// TODO: enable resetMocks
|
|
|
|
|
// resetMocks: true,
|
|
|
|
|
restoreMocks: true,
|
2023-05-19 19:33:02 +02:00
|
|
|
setupFiles: ['<rootDir>/test/setup.js', '<rootDir>/test/env.js'],
|
Add build-time code exclusion using code fencing (#12060)
This PR adds build-time code exclusion by means of code fencing. For details, please see the README in `./development/build/transforms`. Note that linting of transformed files as a form of validation is added in a follow-up, #12075.
Hopefully exhaustive tests are added to ensure that the transform works according to its specification. Since these tests are Node-only, they required their own Jest config. The recommended way to work with multiple Jest configs is using the `projects` field in the Jest config, however [that feature breaks coverage collection](https://github.com/facebook/jest/issues/9628). That being the case, I had to set up two separate Jest configs. In order to get both test suites to run in parallel, Jest is now invoked via a script, `./test/run-jest.sh`.
By way of example, this build system feature allows us to add fences like this:
```javascript
this.store.updateStructure({
...,
GasFeeController: this.gasFeeController,
TokenListController: this.tokenListController,
///: BEGIN:ONLY_INCLUDE_IN(beta)
PluginController: this.pluginController,
///: END:ONLY_INCLUDE_IN
});
```
Which at build time are transformed to the following if the build type is not `beta`:
```javascript
this.store.updateStructure({
...,
GasFeeController: this.gasFeeController,
TokenListController: this.tokenListController,
});
```
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-09-14 19:00:04 +02:00
|
|
|
setupFilesAfterEnv: ['<rootDir>/test/jest/setup.js'],
|
2021-09-21 18:28:13 +02:00
|
|
|
testMatch: [
|
2023-01-11 19:23:38 +01:00
|
|
|
'<rootDir>/app/scripts/constants/error-utils.test.js',
|
2023-02-02 19:56:41 +01:00
|
|
|
'<rootDir>/app/scripts/controllers/app-state.test.js',
|
2023-08-22 11:17:07 +02:00
|
|
|
'<rootDir>/app/scripts/controllers/transactions/etherscan.test.ts',
|
|
|
|
|
'<rootDir>/app/scripts/controllers/transactions/EtherscanRemoteTransactionSource.test.ts',
|
|
|
|
|
'<rootDir>/app/scripts/controllers/transactions/IncomingTransactionHelper.test.ts',
|
2023-05-29 17:38:28 +02:00
|
|
|
'<rootDir>/app/scripts/controllers/mmi-controller.test.js',
|
2022-02-15 01:02:51 +01:00
|
|
|
'<rootDir>/app/scripts/controllers/permissions/**/*.test.js',
|
2023-08-24 12:27:42 +02:00
|
|
|
'<rootDir>/app/scripts/controllers/preferences.test.js',
|
2023-03-20 14:19:50 +01:00
|
|
|
'<rootDir>/app/scripts/controllers/sign.test.ts',
|
2023-04-26 17:02:33 +02:00
|
|
|
'<rootDir>/app/scripts/controllers/decrypt-message.test.ts',
|
2022-09-23 18:56:46 +02:00
|
|
|
'<rootDir>/app/scripts/flask/**/*.test.js',
|
2023-08-23 07:13:13 +02:00
|
|
|
'<rootDir>/app/scripts/lib/**/*.test.(js|ts)',
|
2022-07-20 15:25:04 +02:00
|
|
|
'<rootDir>/app/scripts/lib/createRPCMethodTrackingMiddleware.test.js',
|
2023-06-09 22:48:48 +02:00
|
|
|
'<rootDir>/app/scripts/migrations/*.test.(js|ts)',
|
2023-01-11 19:23:38 +01:00
|
|
|
'<rootDir>/app/scripts/platforms/*.test.js',
|
2023-06-20 14:44:11 +02:00
|
|
|
'<rootDir>/app/scripts/translate.test.ts',
|
2023-01-20 22:16:56 +01:00
|
|
|
'<rootDir>/shared/**/*.test.(js|ts)',
|
2023-02-01 17:51:12 +01:00
|
|
|
'<rootDir>/ui/**/*.test.(js|ts|tsx)',
|
2023-02-09 18:08:48 +01:00
|
|
|
'<rootDir>/development/fitness-functions/**/*.test.(js|ts|tsx)',
|
2023-07-28 20:57:06 +02:00
|
|
|
'<rootDir>/test/e2e/helpers.test.js',
|
2021-09-21 18:28:13 +02:00
|
|
|
],
|
2023-04-10 13:29:07 +02:00
|
|
|
testTimeout: 5500,
|
2022-08-23 22:13:02 +02:00
|
|
|
// We have to specify the environment we are running in, which is jsdom. The
|
|
|
|
|
// default is 'node'. This can be modified *per file* using a comment at the
|
2022-10-04 17:58:22 +02:00
|
|
|
// head of the file. So it may be worthwhile to switch to 'node' in any
|
2022-08-23 22:13:02 +02:00
|
|
|
// background tests.
|
|
|
|
|
testEnvironment: 'jsdom',
|
2022-10-04 17:58:22 +02:00
|
|
|
testEnvironmentOptions: {
|
|
|
|
|
customExportConditions: ['node', 'node-addons'],
|
|
|
|
|
},
|
2022-08-23 22:13:02 +02:00
|
|
|
workerIdleMemoryLimit: '500MB',
|
2021-04-09 19:20:32 +02:00
|
|
|
};
|
