1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-22 17:33:23 +01:00
metamask-extension/.storybook
Erik Marks 31cf7c10a4
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-06 19:16:49 -08:00
..
actions Add send-header to Storybook (#12084) 2021-09-29 13:43:18 -05:00
i18n-party-addon Docs/12367 Adding storybook essentials addons (#12393) 2021-10-29 07:22:07 -10:00
images Add connected-sites component to Storybook (#11415) 2021-08-30 12:56:03 -10:00
initial-states/approval-screens Permission System 2.0 (#12243) 2021-12-06 19:16:49 -08:00
reducers Add send-header to Storybook (#12084) 2021-09-29 13:43:18 -05:00
i18n.js remove the ui/app and ui/lib folders (#10911) 2021-04-28 14:53:59 -05:00
locales.js storybook - i18n toolbar (#10381) 2021-02-06 10:28:54 +08:00
main.js Docs/12367 Adding storybook essentials addons (#12393) 2021-10-29 07:22:07 -10:00
manager.js Updating Storybook base styles (#12862) 2021-12-02 09:11:35 -08:00
metamask-storybook-theme.js Updating styles so they don't override fontawesome, removing duplicate addons (#12971) 2021-12-06 15:55:21 -08:00
metametrics.js Add Approval Confirmation Screen component to Storybook (#10998) 2021-05-25 08:20:09 +08:00
preview-body.html Extract Menu component from ConnectedAccountsListOptions (#8632) 2020-05-20 14:52:23 -03:00
preview-head.html Updating styles so they don't override fontawesome, removing duplicate addons (#12971) 2021-12-06 15:55:21 -08:00
preview.js Updating styles so they don't override fontawesome, removing duplicate addons (#12971) 2021-12-06 15:55:21 -08:00
README.md Switch from npm to yarn (#6843) 2019-07-30 15:36:23 -03:00
test-data.js Permission System 2.0 (#12243) 2021-12-06 19:16:49 -08:00

Storybook

We're currently using Storybook as part of our design system. To run Storybook and test some of our UI components, clone the repo and run the following:

yarn
yarn storybook

You should then see:

info Storybook started on => http://localhost:6006/

In your browser, navigate to http://localhost:6006/ to see the Storybook application. From here, you'll be able to easily view components and even modify some of their properties.