m/metamask-extension
1
0
Fork 0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 09:52:26 +01:00
Code

Merge pull request #12769 from MetaMask/Version-v10.6.1

Browse Source 
Version v10.6.1 RC
This commit is contained in:
ryanml 2021-11-19 15:43:15 -07:00 committed by GitHub
commit f3ade11c74
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 114 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.circleci/scripts/yarn-audit.sh
View File

@ -5,7 +5,7 @@ set -o pipefail
# use `improved-yarn-audit` since that allows for exclude
# exclude 1002401 until we remove use of 3Box, 1002581 until we can find a better solution
yarn run improved-yarn-audit --ignore-dev-deps --min-severity moderate --exclude 1002401,1002581
yarn run improved-yarn-audit --ignore-dev-deps --min-severity moderate --exclude 1002401,1002581,GHSA-93q8-gq69-wqmw,GHSA-257v-vj4p-3w2h
audit_status="$?"
# Use a bitmask to ignore INFO and LOW severity audit results

7
CHANGELOG.md
View File

@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
## [10.6.1]
### Fixed
- [#12573](https://github.com/MetaMask/metamask-extension/pull/12573): Ensure metrics api errors do not impact user experience
## [10.6.0]
### Added
- [#12053](https://github.com/MetaMask/metamask-extension/pull/12053): Add support for GridPlus Lattice1 hardware wallet
@ -2594,7 +2598,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Uncategorized
- Added the ability to restore accounts from seed words.
[Unreleased]: https://github.com/MetaMask/metamask-extension/compare/v10.6.0...HEAD
[Unreleased]: https://github.com/MetaMask/metamask-extension/compare/v10.6.1...HEAD
[10.6.1]: https://github.com/MetaMask/metamask-extension/compare/v10.6.0...v10.6.1
[10.6.0]: https://github.com/MetaMask/metamask-extension/compare/v10.5.2...v10.6.0
[10.5.2]: https://github.com/MetaMask/metamask-extension/compare/v10.5.1...v10.5.2
[10.5.1]: https://github.com/MetaMask/metamask-extension/compare/v10.5.0...v10.5.1

82
app/scripts/controllers/metametrics.js
View File

@ -7,6 +7,18 @@ import {
METAMETRICS_BACKGROUND_PAGE_OBJECT,
} from '../../../shared/constants/metametrics';
const defaultCaptureException = (err) => {
// throw error on clean stack so its captured by platform integrations (eg sentry)
// but does not interupt the call stack
setTimeout(() => {
throw err;
});
};
const exceptionsToFilter = {
[`You must pass either an "anonymousId" or a "userId".`]: true,
};
/**
* @typedef {import('../../../shared/constants/metametrics').MetaMetricsContext} MetaMetricsContext
* @typedef {import('../../../shared/constants/metametrics').MetaMetricsEventPayload} MetaMetricsEventPayload
@ -51,7 +63,15 @@ export default class MetaMetricsController {
version,
environment,
initState,
captureException = defaultCaptureException,
}) {
this._captureException = (err) => {
// This is a temporary measure. Currently there are errors flooding sentry due to a problem in how we are tracking anonymousId
// We intend on removing this as soon as we understand how to correctly solve that problem.
if (!exceptionsToFilter[err.message]) {
captureException(err);
}
};
const prefState = preferencesStore.getState();
this.chainId = getCurrentChainId();
this.network = getNetworkIdentifier();
@ -258,11 +278,15 @@ export default class MetaMetricsController {
* view
*/
trackPage({ name, params, environmentType, page, referrer }, options) {
try {
if (this.state.participateInMetaMetrics === false) {
return;
}
if (this.state.participateInMetaMetrics === null && !options?.isOptInPath) {
if (
this.state.participateInMetaMetrics === null &&
!options?.isOptInPath
) {
return;
}
const { metaMetricsId } = this.state;
@ -280,10 +304,26 @@ export default class MetaMetricsController {
},
context: this._buildContext(referrer, page),
});
} catch (err) {
this._captureException(err);
}
}
/**
* track a metametrics event, performing necessary payload manipulation and
* submits a metametrics event, not waiting for it to complete or allowing its error to bubble up
* @param {MetaMetricsEventPayload} payload - details of the event
* @param {MetaMetricsEventOptions} [options] - options for handling/routing the event
*/
trackEvent(payload, options) {
// validation is not caught and handled
this.validatePayload(payload);
this.submitEvent(payload, options).catch((err) =>
this._captureException(err),
);
}
/**
* submits (or queues for submission) a metametrics event, performing necessary payload manipulation and
* routing the event to the appropriate segment source. Will split events
* with sensitiveProperties into two events, tracking the sensitiveProperties
* with the anonymousId only.
@ -291,21 +331,8 @@ export default class MetaMetricsController {
* @param {MetaMetricsEventOptions} [options] - options for handling/routing the event
* @returns {Promise<void>}
*/
async trackEvent(payload, options) {
// event and category are required fields for all payloads
if (!payload.event || !payload.category) {
throw new Error(
`Must specify event and category. Event was: ${
payload.event
}. Category was: ${payload.category}. Payload keys were: ${Object.keys(
payload,
)}. ${
typeof payload.properties === 'object'
? `Payload property keys were: ${Object.keys(payload.properties)}`
: ''
}`,
);
}
async submitEvent(payload, options) {
this.validatePayload(payload);
if (!this.state.participateInMetaMetrics && !options?.isOptIn) {
return;
@ -345,4 +372,25 @@ export default class MetaMetricsController {
await Promise.all(events);
}
/**
* validates a metametrics event
* @param {MetaMetricsEventPayload} payload - details of the event
*/
validatePayload(payload) {
// event and category are required fields for all payloads
if (!payload.event || !payload.category) {
throw new Error(
`Must specify event and category. Event was: ${
payload.event
}. Category was: ${payload.category}. Payload keys were: ${Object.keys(
payload,
)}. ${
typeof payload.properties === 'object'
? `Payload property keys were: ${Object.keys(payload.properties)}`
: ''
}`,
);
}
}
}

22
app/scripts/controllers/metametrics.test.js
View File

@ -196,14 +196,14 @@ describe('MetaMetricsController', function () {
});
});
describe('trackEvent', function () {
describe('submitEvent', function () {
it('should not track an event if user is not participating in metametrics', function () {
const mock = sinon.mock(segment);
const metaMetricsController = getMetaMetricsController({
participateInMetaMetrics: false,
});
mock.expects('track').never();
metaMetricsController.trackEvent({
metaMetricsController.submitEvent({
event: 'Fake Event',
category: 'Unit Test',
properties: {
@ -230,7 +230,7 @@ describe('MetaMetricsController', function () {
...DEFAULT_EVENT_PROPERTIES,
},
});
metaMetricsController.trackEvent(
metaMetricsController.submitEvent(
{
event: 'Fake Event',
category: 'Unit Test',
@ -260,7 +260,7 @@ describe('MetaMetricsController', function () {
...DEFAULT_EVENT_PROPERTIES,
},
});
metaMetricsController.trackEvent(
metaMetricsController.submitEvent(
{
event: 'Fake Event',
category: 'Unit Test',
@ -289,7 +289,7 @@ describe('MetaMetricsController', function () {
...DEFAULT_EVENT_PROPERTIES,
},
});
metaMetricsController.trackEvent(
metaMetricsController.submitEvent(
{
event: 'Fake Event',
category: 'Unit Test',
@ -317,7 +317,7 @@ describe('MetaMetricsController', function () {
...DEFAULT_EVENT_PROPERTIES,
},
});
metaMetricsController.trackEvent({
metaMetricsController.submitEvent({
event: 'Fake Event',
category: 'Unit Test',
properties: {
@ -331,7 +331,7 @@ describe('MetaMetricsController', function () {
const metaMetricsController = getMetaMetricsController();
const flushStub = sinon.stub(segment, 'flush');
const flushCalled = waitUntilCalled(flushStub, segment);
metaMetricsController.trackEvent(
metaMetricsController.submitEvent(
{
event: 'Fake Event',
category: 'Unit Test',
@ -344,13 +344,13 @@ describe('MetaMetricsController', function () {
it('should throw if event or category not provided', function () {
const metaMetricsController = getMetaMetricsController();
assert.rejects(
() => metaMetricsController.trackEvent({ event: 'test' }),
() => metaMetricsController.submitEvent({ event: 'test' }),
/Must specify event and category\./u,
'must specify category',
);
assert.rejects(
() => metaMetricsController.trackEvent({ category: 'test' }),
() => metaMetricsController.submitEvent({ category: 'test' }),
/Must specify event and category\./u,
'must specify event',
);
@ -360,7 +360,7 @@ describe('MetaMetricsController', function () {
const metaMetricsController = getMetaMetricsController();
assert.rejects(
() =>
metaMetricsController.trackEvent(
metaMetricsController.submitEvent(
{
event: 'Fake Event',
category: 'Unit Test',
@ -375,7 +375,7 @@ describe('MetaMetricsController', function () {
it('should track sensitiveProperties in a separate, anonymous event', function () {
const metaMetricsController = getMetaMetricsController();
const spy = sinon.spy(segment, 'track');
metaMetricsController.trackEvent({
metaMetricsController.submitEvent({
event: 'Fake Event',
category: 'Unit Test',
sensitiveProperties: { foo: 'bar' },

2
app/scripts/metamask-controller.js
View File

@ -17,6 +17,7 @@ import LedgerBridgeKeyring from '@metamask/eth-ledger-bridge-keyring';
import LatticeKeyring from 'eth-lattice-keyring';
import EthQuery from 'eth-query';
import nanoid from 'nanoid';
import { captureException } from '@sentry/browser';
import {
AddressBookController,
ApprovalController,
@ -190,6 +191,7 @@ export default class MetamaskController extends EventEmitter {
version: this.platform.getVersion(),
environment: process.env.METAMASK_ENVIRONMENT,
initState: initState.MetaMetricsController,
captureException,
});
const gasFeeMessenger = this.controllerMessenger.getRestricted({

4
package.json
View File

@ -1,6 +1,6 @@
{
"name": "metamask-crx",
"version": "10.6.0",
"version": "10.6.1",
"private": true,
"repository": {
"type": "git",
@ -292,7 +292,7 @@
"gulp-watch": "^5.0.1",
"gulp-zip": "^4.0.0",
"history": "^5.0.0",
"improved-yarn-audit": "^2.3.3",
"improved-yarn-audit": "^3.0.0",
"jest": "^26.6.3",
"jsdom": "^11.2.0",
"koa": "^2.7.0",

2
ui/components/app/dropdowns/network-dropdown.js
View File

@ -68,7 +68,7 @@ function mapDispatchToProps(dispatch) {
}),
);
},
hideTestNetMessage: () => dispatch(actions.hideTestNetMessage()),
hideTestNetMessage: () => actions.hideTestNetMessage(),
};
}

14
yarn.lock
View File

@ -6510,9 +6510,9 @@ ansi-regex@^4.1.0:
integrity sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==
ansi-regex@^5.0.0:
version "5.0.0"
resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.0.tgz#388539f55179bf39339c81af30a654d69f87cb75"
integrity sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==
version "5.0.1"
resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.1.tgz#082cb2c89c9fe8659a311a53bd6a4dc5301db304"
integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==
ansi-styles@^2.2.1:
version "2.2.1"
@ -16243,10 +16243,10 @@ import-local@^3.0.2:
pkg-dir "^4.2.0"
resolve-cwd "^3.0.0"
improved-yarn-audit@^2.3.3:
version "2.3.3"
resolved "https://registry.yarnpkg.com/improved-yarn-audit/-/improved-yarn-audit-2.3.3.tgz#da0be78be4b678c73733066c9ccd21e1958fae8c"
integrity sha512-chZ7zPKGsA+CZeMExNPf9WZhETJLkC+u8cQlkQC9XyPZqQPctn3FavefTjXBXmX3Azin8WcoAbaok1FvjkLf6A==
improved-yarn-audit@^3.0.0:
version "3.0.0"
resolved "https://registry.yarnpkg.com/improved-yarn-audit/-/improved-yarn-audit-3.0.0.tgz#dfb09cea1a3a92c790ea2b4056431f6fb1b99bfa"
integrity sha512-b7CrBYYwMidtPciCBkW62C7vqGjAV10bxcAWHeJvGrltrcMSEnG5I9CQgi14nmAlUKUQiSvpz47Lo3d7Z3Vjcg==
imurmurhash@^0.1.4:
version "0.1.4"