Sentry e2e test (#15715)

app/scripts/lib/setupSentry.js

@@ -11,6 +11,7 @@ const METAMASK_DEBUG = process.env.METAMASK_DEBUG;
 const METAMASK_ENVIRONMENT = process.env.METAMASK_ENVIRONMENT;
 const SENTRY_DSN_DEV = process.env.SENTRY_DSN_DEV;
 const METAMASK_BUILD_TYPE = process.env.METAMASK_BUILD_TYPE;
+const IN_TEST = process.env.IN_TEST;
 /* eslint-enable prefer-destructuring */
 
 // This describes the subset of Redux state attached to errors sent to Sentry
@@ -71,7 +72,13 @@ export const SENTRY_STATE = {
 export default function setupSentry({ release, getState }) {
   if (!release) {
     throw new Error('Missing release');
-  } else if (METAMASK_DEBUG) {
+  } else if (METAMASK_DEBUG && !IN_TEST) {
+    /**
+     * Workaround until the following issue is resolved
+     * https://github.com/MetaMask/metamask-extension/issues/15691
+     * The IN_TEST condition allows the e2e tests to run with both
+     * yarn start:test and yarn build:test
+     */
     return undefined;
   }
 

package.json

@@ -15,12 +15,12 @@
     "dist": "yarn build dist",
     "build": "yarn lavamoat:build",
     "build:dev": "node development/build/index.js",
-    "start:test": "SEGMENT_HOST='https://api.segment.io' SEGMENT_WRITE_KEY='FAKE' yarn build testDev",
+    "start:test": "SEGMENT_HOST='https://api.segment.io' SEGMENT_WRITE_KEY='FAKE' SENTRY_DSN_DEV=https://fake@sentry.io/0000000 yarn build testDev",
     "benchmark:chrome": "SELENIUM_BROWSER=chrome node test/e2e/benchmark.js",
     "mv3:stats:chrome": "SELENIUM_BROWSER=chrome ENABLE_MV3=true node test/e2e/mv3-perf-stats/index.js",
     "user-actions-benchmark:chrome": "SELENIUM_BROWSER=chrome node test/e2e/user-actions-benchmark.js",
     "benchmark:firefox": "SELENIUM_BROWSER=firefox node test/e2e/benchmark.js",
-    "build:test": "SEGMENT_HOST='https://api.segment.io' SEGMENT_WRITE_KEY='FAKE' yarn build test",
+    "build:test": "SEGMENT_HOST='https://api.segment.io' SEGMENT_WRITE_KEY='FAKE' SENTRY_DSN_DEV=https://fake@sentry.io/0000000 yarn build test",
     "build:test:flask": "yarn build test --build-type flask",
     "build:test:mv3": "ENABLE_MV3=true yarn build test",
     "test": "yarn lint && yarn test:unit && yarn test:unit:jest",

test/e2e/mock-e2e.js

@@ -25,6 +25,24 @@ async function setupMocking(server, testSpecificMock) {
     };
   });
 
+  await server
+    .forPost('https://sentry.io/api/0000000/envelope/')
+    .thenCallback(() => {
+      return {
+        statusCode: 200,
+        json: {},
+      };
+    });
+
+  await server
+    .forPost('https://sentry.io/api/0000000/store/')
+    .thenCallback(() => {
+      return {
+        statusCode: 200,
+        json: {},
+      };
+    });
+
   await server
     .forGet('https://www.4byte.directory/api/v1/signatures/')
     .thenCallback(() => {

test/e2e/tests/errors.spec.js

@@ -0,0 +1,67 @@
+const { strict: assert } = require('assert');
+const { convertToHexValue, withFixtures } = require('../helpers');
+
+describe('Sentry errors', function () {
+  async function mockSegment(mockServer) {
+    mockServer.reset();
+    await mockServer.forAnyRequest().thenPassThrough();
+    return await mockServer
+      .forPost('https://sentry.io/api/0000000/store/')
+      .thenCallback(() => {
+        return {
+          statusCode: 200,
+          json: {},
+        };
+      });
+  }
+  const ganacheOptions = {
+    accounts: [
+      {
+        secretKey:
+          '0x7C9529A67102755B7E6102D6D950AC5D5863C98713805CEC576B945B15B71EAC',
+        balance: convertToHexValue(25000000000000000000),
+      },
+    ],
+  };
+  it('should send error events', async function () {
+    await withFixtures(
+      {
+        fixtures: 'metrics-enabled',
+        ganacheOptions,
+        title: this.test.title,
+        failOnConsoleError: false,
+      },
+      async ({ driver, mockServer }) => {
+        const mockedEndpoint = await mockSegment(mockServer);
+        await driver.navigate();
+        await driver.fill('#password', 'correct horse battery staple');
+        await driver.press('#password', driver.Key.ENTER);
+        // Trigger error
+        await driver.clickElement('[data-testid="eth-overview-send"]');
+        await driver.fill(
+          'input[placeholder="Search, public address (0x), or ENS"]',
+          '0x2f318C334780961FB129D2a6c30D0763d9a5C970',
+        );
+        await driver.fill('input[placeholder="0"]', `-01`);
+        // Wait for Sentry request
+        await driver.wait(async () => {
+          const isPending = await mockedEndpoint.isPending();
+          return isPending === false;
+        }, 10000);
+        const [mockedRequest] = await mockedEndpoint.getSeenRequests();
+        const mockJsonBody = mockedRequest.body.json;
+        const { level, extra } = mockJsonBody;
+        const [{ type, value }] = mockJsonBody.exception.values;
+        const { participateInMetaMetrics } = extra.appState.store.metamask;
+        // Verify request
+        assert.equal(type, 'BigNumber Error');
+        assert.equal(
+          value,
+          'new BigNumber() not a base 16 number: 0x-de0b6b3a7640000',
+        );
+        assert.equal(level, 'error');
+        assert.equal(participateInMetaMetrics, true);
+      },
+    );
+  });
+});

test/e2e/tests/metrics.spec.js

@@ -30,6 +30,7 @@ describe('Segment metrics', function () {
         fixtures: 'metrics-enabled',
         ganacheOptions,
         title: this.test.title,
+        failOnConsoleError: false,
       },
       async ({ driver, mockServer }) => {
         const mockedEndpoints = await mockSegment(mockServer);