mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-10-22 11:22:43 +02:00
wallet created metrics tests (#19791)
Co-authored-by: Danica Shen <zhaodanica@gmail.com>
This commit is contained in:
parent
a2dfe8d113
commit
12bd60ee79
@ -294,22 +294,52 @@ const completeImportSRPOnboardingFlowWordByWord = async (
|
|||||||
await driver.clickElement('[data-testid="pin-extension-done"]');
|
await driver.clickElement('[data-testid="pin-extension-done"]');
|
||||||
};
|
};
|
||||||
|
|
||||||
const completeCreateNewWalletOnboardingFlow = async (driver, password) => {
|
/**
|
||||||
|
* Begin the create new wallet flow on onboarding screen.
|
||||||
|
*
|
||||||
|
* @param {WebDriver} driver
|
||||||
|
*/
|
||||||
|
const onboardingBeginCreateNewWallet = async (driver) => {
|
||||||
// agree to terms of use
|
// agree to terms of use
|
||||||
await driver.clickElement('[data-testid="onboarding-terms-checkbox"]');
|
await driver.clickElement('[data-testid="onboarding-terms-checkbox"]');
|
||||||
|
|
||||||
// welcome
|
// welcome
|
||||||
await driver.clickElement('[data-testid="onboarding-create-wallet"]');
|
await driver.clickElement('[data-testid="onboarding-create-wallet"]');
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Choose either "I Agree" or "No Thanks" on the MetaMetrics onboarding screen
|
||||||
|
*
|
||||||
|
* @param {WebDriver} driver
|
||||||
|
* @param {boolean} optin - true to opt into metrics, default is false
|
||||||
|
*/
|
||||||
|
const onboardingChooseMetametricsOption = async (driver, optin = false) => {
|
||||||
|
const optionIdentifier = optin ? 'i-agree' : 'no-thanks';
|
||||||
// metrics
|
// metrics
|
||||||
await driver.clickElement('[data-testid="metametrics-no-thanks"]');
|
await driver.clickElement(`[data-testid="metametrics-${optionIdentifier}"]`);
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set a password for MetaMask during onboarding
|
||||||
|
*
|
||||||
|
* @param {WebDriver} driver
|
||||||
|
* @param {string} password - Password to set
|
||||||
|
*/
|
||||||
|
const onboardingCreatePassword = async (driver, password) => {
|
||||||
// create password
|
// create password
|
||||||
await driver.fill('[data-testid="create-password-new"]', password);
|
await driver.fill('[data-testid="create-password-new"]', password);
|
||||||
await driver.fill('[data-testid="create-password-confirm"]', password);
|
await driver.fill('[data-testid="create-password-confirm"]', password);
|
||||||
await driver.clickElement('[data-testid="create-password-terms"]');
|
await driver.clickElement('[data-testid="create-password-terms"]');
|
||||||
await driver.clickElement('[data-testid="create-password-wallet"]');
|
await driver.clickElement('[data-testid="create-password-wallet"]');
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Choose to secure wallet, and then get recovery phrase and confirm the SRP
|
||||||
|
* during onboarding flow.
|
||||||
|
*
|
||||||
|
* @param {WebDriver} driver
|
||||||
|
*/
|
||||||
|
const onboardingRevealAndConfirmSRP = async (driver) => {
|
||||||
// secure my wallet
|
// secure my wallet
|
||||||
await driver.clickElement('[data-testid="secure-wallet-recommended"]');
|
await driver.clickElement('[data-testid="secure-wallet-recommended"]');
|
||||||
|
|
||||||
@ -336,16 +366,40 @@ const completeCreateNewWalletOnboardingFlow = async (driver, password) => {
|
|||||||
await driver.clickElement('[data-testid="confirm-recovery-phrase"]');
|
await driver.clickElement('[data-testid="confirm-recovery-phrase"]');
|
||||||
|
|
||||||
await driver.clickElement({ text: 'Confirm', tag: 'button' });
|
await driver.clickElement({ text: 'Confirm', tag: 'button' });
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Complete the onboarding flow by confirming completion. Final step before the
|
||||||
|
* reminder to pin the extension.
|
||||||
|
*
|
||||||
|
* @param {WebDriver} driver
|
||||||
|
*/
|
||||||
|
const onboardingCompleteWalletCreation = async (driver) => {
|
||||||
// complete
|
// complete
|
||||||
await driver.findElement({ text: 'Wallet creation successful', tag: 'h2' });
|
await driver.findElement({ text: 'Wallet creation successful', tag: 'h2' });
|
||||||
await driver.clickElement('[data-testid="onboarding-complete-done"]');
|
await driver.clickElement('[data-testid="onboarding-complete-done"]');
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Move through the steps of pinning extension after successful onboarding
|
||||||
|
*
|
||||||
|
* @param {WebDriver} driver
|
||||||
|
*/
|
||||||
|
const onboardingPinExtension = async (driver) => {
|
||||||
// pin extension
|
// pin extension
|
||||||
await driver.clickElement('[data-testid="pin-extension-next"]');
|
await driver.clickElement('[data-testid="pin-extension-next"]');
|
||||||
await driver.clickElement('[data-testid="pin-extension-done"]');
|
await driver.clickElement('[data-testid="pin-extension-done"]');
|
||||||
};
|
};
|
||||||
|
|
||||||
|
const completeCreateNewWalletOnboardingFlow = async (driver, password) => {
|
||||||
|
await onboardingBeginCreateNewWallet(driver);
|
||||||
|
await onboardingChooseMetametricsOption(driver, false);
|
||||||
|
await onboardingCreatePassword(driver, password);
|
||||||
|
await onboardingRevealAndConfirmSRP(driver);
|
||||||
|
await onboardingCompleteWalletCreation(driver);
|
||||||
|
await onboardingPinExtension(driver);
|
||||||
|
};
|
||||||
|
|
||||||
const importWrongSRPOnboardingFlow = async (driver, seedPhrase) => {
|
const importWrongSRPOnboardingFlow = async (driver, seedPhrase) => {
|
||||||
// agree to terms of use
|
// agree to terms of use
|
||||||
await driver.clickElement('[data-testid="onboarding-terms-checkbox"]');
|
await driver.clickElement('[data-testid="onboarding-terms-checkbox"]');
|
||||||
@ -687,6 +741,30 @@ async function switchToNotificationWindow(driver) {
|
|||||||
await driver.switchToWindowWithTitle('MetaMask Notification', windowHandles);
|
await driver.switchToWindowWithTitle('MetaMask Notification', windowHandles);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* When mocking the segment server and returning an array of mocks from the
|
||||||
|
* mockServer method, this method will allow getting all of the seen requests
|
||||||
|
* for each mock in the array.
|
||||||
|
*
|
||||||
|
* @param {WebDriver} driver
|
||||||
|
* @param {import('mockttp').Mockttp} mockedEndpoints
|
||||||
|
* @returns {import('mockttp/dist/pluggable-admin').MockttpClientResponse[]}
|
||||||
|
*/
|
||||||
|
async function getEventPayloads(driver, mockedEndpoints) {
|
||||||
|
await driver.wait(async () => {
|
||||||
|
let isPending = true;
|
||||||
|
for (const mockedEndpoint of mockedEndpoints) {
|
||||||
|
isPending = await mockedEndpoint.isPending();
|
||||||
|
}
|
||||||
|
return isPending === false;
|
||||||
|
}, 10000);
|
||||||
|
const mockedRequests = [];
|
||||||
|
for (const mockedEndpoint of mockedEndpoints) {
|
||||||
|
mockedRequests.push(...(await mockedEndpoint.getSeenRequests()));
|
||||||
|
}
|
||||||
|
return mockedRequests.map((req) => req.body.json.batch).flat();
|
||||||
|
}
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
DAPP_URL,
|
DAPP_URL,
|
||||||
DAPP_ONE_URL,
|
DAPP_ONE_URL,
|
||||||
@ -734,4 +812,11 @@ module.exports = {
|
|||||||
sleepSeconds,
|
sleepSeconds,
|
||||||
terminateServiceWorker,
|
terminateServiceWorker,
|
||||||
switchToNotificationWindow,
|
switchToNotificationWindow,
|
||||||
|
getEventPayloads,
|
||||||
|
onboardingBeginCreateNewWallet,
|
||||||
|
onboardingChooseMetametricsOption,
|
||||||
|
onboardingCreatePassword,
|
||||||
|
onboardingRevealAndConfirmSRP,
|
||||||
|
onboardingCompleteWalletCreation,
|
||||||
|
onboardingPinExtension,
|
||||||
};
|
};
|
||||||
|
@ -6,6 +6,7 @@ const {
|
|||||||
regularDelayMs,
|
regularDelayMs,
|
||||||
openDapp,
|
openDapp,
|
||||||
unlockWallet,
|
unlockWallet,
|
||||||
|
getEventPayloads,
|
||||||
} = require('../helpers');
|
} = require('../helpers');
|
||||||
const FixtureBuilder = require('../fixture-builder');
|
const FixtureBuilder = require('../fixture-builder');
|
||||||
|
|
||||||
@ -76,28 +77,6 @@ async function clickSignOnSignatureConfirmation(driver) {
|
|||||||
await driver.getAllWindowHandles();
|
await driver.getAllWindowHandles();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* This method handles getting the mocked requests to the segment server
|
|
||||||
*
|
|
||||||
* @param {WebDriver} driver
|
|
||||||
* @param {import('mockttp').Mockttp} mockedEndpoints
|
|
||||||
* @returns {import('mockttp/dist/pluggable-admin').MockttpClientResponse[]}
|
|
||||||
*/
|
|
||||||
async function getEventPayloads(driver, mockedEndpoints) {
|
|
||||||
await driver.wait(async () => {
|
|
||||||
let isPending = true;
|
|
||||||
for (const mockedEndpoint of mockedEndpoints) {
|
|
||||||
isPending = await mockedEndpoint.isPending();
|
|
||||||
}
|
|
||||||
return isPending === false;
|
|
||||||
}, 10000);
|
|
||||||
const mockedRequests = [];
|
|
||||||
for (const mockedEndpoint of mockedEndpoints) {
|
|
||||||
mockedRequests.push(...(await mockedEndpoint.getSeenRequests()));
|
|
||||||
}
|
|
||||||
return mockedRequests.map((req) => req.body.json.batch).flat();
|
|
||||||
}
|
|
||||||
|
|
||||||
describe('Signature Approved Event', function () {
|
describe('Signature Approved Event', function () {
|
||||||
it('Successfully tracked for signTypedData_v4', async function () {
|
it('Successfully tracked for signTypedData_v4', async function () {
|
||||||
await withFixtures(
|
await withFixtures(
|
||||||
|
93
test/e2e/metrics/wallet-created.spec.js
Normal file
93
test/e2e/metrics/wallet-created.spec.js
Normal file
@ -0,0 +1,93 @@
|
|||||||
|
const { strict: assert } = require('assert');
|
||||||
|
const {
|
||||||
|
defaultGanacheOptions,
|
||||||
|
withFixtures,
|
||||||
|
WALLET_PASSWORD,
|
||||||
|
onboardingBeginCreateNewWallet,
|
||||||
|
onboardingChooseMetametricsOption,
|
||||||
|
onboardingCreatePassword,
|
||||||
|
onboardingRevealAndConfirmSRP,
|
||||||
|
onboardingCompleteWalletCreation,
|
||||||
|
onboardingPinExtension,
|
||||||
|
getEventPayloads,
|
||||||
|
} = require('../helpers');
|
||||||
|
const FixtureBuilder = require('../fixture-builder');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* mocks the segment api multiple times for specific payloads that we expect to
|
||||||
|
* see when these tests are run. In this case we are looking for
|
||||||
|
* 'Permissions Requested' and 'Permissions Received'. Do not use the constants
|
||||||
|
* from the metrics constants files, because if these change we want a strong
|
||||||
|
* indicator to our data team that the shape of data will change.
|
||||||
|
*
|
||||||
|
* @param {import('mockttp').Mockttp} mockServer
|
||||||
|
* @returns {Promise<import('mockttp/dist/pluggable-admin').MockttpClientResponse>[]}
|
||||||
|
*/
|
||||||
|
async function mockSegment(mockServer) {
|
||||||
|
return [
|
||||||
|
await mockServer
|
||||||
|
.forPost('https://api.segment.io/v1/batch')
|
||||||
|
.withJsonBodyIncluding({
|
||||||
|
batch: [{ type: 'track', event: 'Wallet Setup Selected' }],
|
||||||
|
})
|
||||||
|
.thenCallback(() => {
|
||||||
|
return {
|
||||||
|
statusCode: 200,
|
||||||
|
};
|
||||||
|
}),
|
||||||
|
await mockServer
|
||||||
|
.forPost('https://api.segment.io/v1/batch')
|
||||||
|
.withJsonBodyIncluding({
|
||||||
|
batch: [{ type: 'track', event: 'Wallet Created' }],
|
||||||
|
})
|
||||||
|
.thenCallback(() => {
|
||||||
|
return {
|
||||||
|
statusCode: 200,
|
||||||
|
};
|
||||||
|
}),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('Wallet Created Event', function () {
|
||||||
|
it('Successfully tracked when onboarding', async function () {
|
||||||
|
await withFixtures(
|
||||||
|
{
|
||||||
|
fixtures: new FixtureBuilder({ onboarding: true })
|
||||||
|
.withMetaMetricsController({
|
||||||
|
metaMetricsId: 'fake-metrics-id',
|
||||||
|
participateInMetaMetrics: true,
|
||||||
|
})
|
||||||
|
.build(),
|
||||||
|
defaultGanacheOptions,
|
||||||
|
title: this.test.title,
|
||||||
|
testSpecificMock: mockSegment,
|
||||||
|
},
|
||||||
|
async ({ driver, mockedEndpoint: mockedEndpoints }) => {
|
||||||
|
await driver.navigate();
|
||||||
|
|
||||||
|
await onboardingBeginCreateNewWallet(driver);
|
||||||
|
await onboardingChooseMetametricsOption(driver, true);
|
||||||
|
await onboardingCreatePassword(driver, WALLET_PASSWORD);
|
||||||
|
await onboardingRevealAndConfirmSRP(driver);
|
||||||
|
await onboardingCompleteWalletCreation(driver);
|
||||||
|
await onboardingPinExtension(driver);
|
||||||
|
|
||||||
|
const events = await getEventPayloads(driver, mockedEndpoints);
|
||||||
|
assert.deepStrictEqual(events[0].properties, {
|
||||||
|
account_type: 'metamask',
|
||||||
|
category: 'Onboarding',
|
||||||
|
locale: 'en',
|
||||||
|
chain_id: '0x539',
|
||||||
|
environment_type: 'fullscreen',
|
||||||
|
});
|
||||||
|
assert.deepStrictEqual(events[1].properties, {
|
||||||
|
method: 'create',
|
||||||
|
category: 'Onboarding',
|
||||||
|
locale: 'en',
|
||||||
|
chain_id: '0x539',
|
||||||
|
environment_type: 'fullscreen',
|
||||||
|
});
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
Loading…
Reference in New Issue
Block a user