metamask-extension/test/e2e/tests/errors.spec.js

const { strict: assert } = require('assert');
const { convertToHexValue, withFixtures } = require('../helpers');
const FixtureBuilder = require('../fixture-builder');

describe('Sentry errors', function () {
  async function mockSentry(mockServer) {
    return await mockServer
      .forPost('https://sentry.io/api/0000000/envelope/')
      .withBodyIncluding('Test Error')
      .thenCallback(() => {
        return {
          statusCode: 200,
          json: {},
        };
      });
  }
  const ganacheOptions = {
    accounts: [
      {
        secretKey:
          '0x7C9529A67102755B7E6102D6D950AC5D5863C98713805CEC576B945B15B71EAC',
        balance: convertToHexValue(25000000000000000000),
      },
    ],
  };
  it('should NOT send error events when participateInMetaMetrics is false', async function () {
    await withFixtures(
      {
        fixtures: new FixtureBuilder()
          .withMetaMetricsController({
            metaMetricsId: null,
            participateInMetaMetrics: false,
          })
          .build(),
        ganacheOptions,
        title: this.test.title,
        failOnConsoleError: false,
        testSpecificMock: mockSentry,
      },
      async ({ driver, mockedEndpoint }) => {
        await driver.navigate();
        await driver.fill('#password', 'correct horse battery staple');
        await driver.press('#password', driver.Key.ENTER);
        // Trigger error
        driver.executeScript('window.stateHooks.throwTestError()');
        driver.delay(3000);
        // Wait for Sentry request
        const isPending = await mockedEndpoint.isPending();
        assert.ok(
          isPending,
          'A request to sentry was sent when it should not have been',
        );
      },
    );
  });
  it('should send error events', async function () {
    await withFixtures(
      {
        fixtures: new FixtureBuilder()
          .withMetaMetricsController({
            metaMetricsId: 'fake-metrics-id',
            participateInMetaMetrics: true,
          })
          .build(),
        ganacheOptions,
        title: this.test.title,
        failOnConsoleError: false,
        testSpecificMock: mockSentry,
      },
      async ({ driver, mockedEndpoint }) => {
        await driver.navigate();
        await driver.fill('#password', 'correct horse battery staple');
        await driver.press('#password', driver.Key.ENTER);
        // Trigger error
        driver.executeScript('window.stateHooks.throwTestError()');
        // Wait for Sentry request
        await driver.wait(async () => {
          const isPending = await mockedEndpoint.isPending();
          return isPending === false;
        }, 10000);
        const [mockedRequest] = await mockedEndpoint.getSeenRequests();
        const mockTextBody = mockedRequest.body.text.split('\n');
        const mockJsonBody = JSON.parse(mockTextBody[2]);
        const { level, extra } = mockJsonBody;
        const [{ type, value }] = mockJsonBody.exception.values;
        const { participateInMetaMetrics } = extra.appState.store.metamask;
        // Verify request
        assert.equal(type, 'TestError');
        assert.equal(value, 'Test Error');
        assert.equal(level, 'error');
        assert.equal(participateInMetaMetrics, true);
      },
    );
  });
});