mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-22 09:57:02 +01:00
fa336b5137
The "scripts" portion of the build script has been refactored to pass the "build target" throughout the file. The "build target" is the target environment for the build, reflected by the command used to start the build (e.g. "dev", "prod", "test", or "testDev"). Beforehand we derived the variables `devMode` and `testing` from this build target, and passed these throughout the script. However, there is a future change [1] that requires adding a new build target that acts like "prod" in some ways but not others. It was easier to refactor to pass through `buildTarget` directly than it was to add a _third_ boolean flag to indirectly represent the target. The existence of the "testDev" target made it convenient to still have the `testing` and `devMode` flag, so helper functions were added to derive those values from the build target. I anticipate that these will only be needed temporarily though. We will probably be able to get rid of the `testDev` target and the related complexities when we start adding more flags (like `--watch`[2] and `--minify`[3]) to the build script directly. [1]: https://github.com/MetaMask/metamask-extension/issues/15003 [2]: https://github.com/MetaMask/metamask-extension/issues/12767 [3]: https://github.com/MetaMask/metamask-extension/issues/12768 |
||
|---|---|---|
| .. | ||
| build | ||
| charts | ||
| highlights | ||
| lib | ||
| states | ||
| announcer.js | ||
| chromereload.js | ||
| create-static-server.js | ||
| empty.js | ||
| generate-lavamoat-policies.sh | ||
| generate-migration.sh | ||
| gource-viz.sh | ||
| jest.config.js | ||
| metamaskbot-build-announce.js | ||
| missing-locale-strings.js | ||
| mock-3box.js | ||
| mock-segment.js | ||
| README.md | ||
| run-ganache.sh | ||
| sentry-publish.js | ||
| sentry-upload-artifacts.sh | ||
| shellcheck.sh | ||
| show-deps-install-scripts.js | ||
| source-map-explorer.sh | ||
| sourcemap-validator.js | ||
| static-server.js | ||
| stream-flat-map.js | ||
| verify-locale-strings.js | ||
Development
Several files which are needed for developing on MetaMask.
Usually each file or directory contains information about its scope / usage.
Segment
Debugging with the Mock Segment API
To start the Mock Segment API:
- Add/replace the
SEGMENT_HOSTandSEGMENT_WRITE_KEYvariables in.metamaskrcSEGMENT_HOST='http://localhost:9090' SEGMENT_WRITE_KEY='FAKE' - Build the project to the
./dist/folder withyarn dist - Run the Mock Segment API from the command line
node development/mock-segment.js
Events triggered whilst using the extension will be logged to the console of the Mock Segment API.
More information on the API and its usage can be found here.
Debugging in Segment
To debug in a production Segment environment:
- Create a free account on Segment
- Create a New Workspace
- Add a Source (Node.js)
- Copy the
Write Keyfrom the API Keys section under Settings - Add/replace the
SEGMENT_HOSTandSEGMENT_WRITE_KEYvariables in.metamaskrcSEGMENT_HOST='https://api.segment.io' SEGMENT_WRITE_KEY='COPIED_WRITE_KEY' - Build the project to the
./dist/folder withyarn dist
Events triggered whilst using the extension will be displayed in Segment's Debugger.
Debugging Segment requests in MetaMask
To opt in to MetaMetrics;
- Unlock the extension
- Open the Account menu
- Click the
Settingsmenu item - Click the
Security & Privacymenu item - Toggle the
Participate in MetaMetricsmenu option to theONposition
You can inspect the requests in the Network tab of your browser's Developer Tools (background.html)
by filtering for POST requests to /v1/batch. The full url will be http://localhost:9090/v1/batch
or https://api.segment.io/v1/batch respectively.
Sentry
Debugging in Sentry
To debug in a production Sentry environment:
- If you have not already got a Sentry account, you can create a free account on Sentry
- Create a New Sentry Organization
- If you already have an existing Sentry account and workspace, open the sidebar drop down menu, then click
Switch organizationfollowed byCreate a new organization
- If you already have an existing Sentry account and workspace, open the sidebar drop down menu, then click
- Create a New Project
- Copy the
Public KeyandProject IDfrom the Client Keys section under your projects Settings- Select
Settingsin the sidebar menu, then selectProjectsin the secondary menu. Click your project then selectClient Keys (DSN)from the secondary menu. Click theConfigurebutton on theClient Keyspage and copy yourProject IdandPublic Key
- Select
- Add/replace the
SENTRY_DSNandSENTRY_DSN_DEVvariables in.metamaskrcSENTRY_DSN_DEV=https://{SENTRY_PUBLIC_KEY}@sentry.io/{SENTRY_PROJECT_ID} SENTRY_DSN=https://{SENTRY_PUBLIC_KEY}@sentry.io/{SENTRY_PROJECT_ID} - Build the project to the
./dist/folder withyarn dist
Errors reported whilst using the extension will be displayed in Sentry's Issues page.