Skip to content

Commit

Permalink
test: Adding unit test for setupPhishingCommunication and setUpCookie…
Browse files Browse the repository at this point in the history
…HandlerCommunication (#27736)

Adding unit test for setupPhishingCommunication and
setUpCookieHandlerCommunication.

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/27736?quickstart=1)

## **Related issues**

Fixes: #27119
## **Manual testing steps**

1. Go to this page...
2.
3.

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [ ] I've completed the PR template to the best of my ability
- [ ] I’ve included tests if applicable
- [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [ ] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.
  • Loading branch information
NiranjanaBinoy authored Nov 24, 2024
1 parent 23ec947 commit 9eff241
Showing 1 changed file with 124 additions and 0 deletions.
124 changes: 124 additions & 0 deletions app/scripts/metamask-controller.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ import {
} from './lib/accounts/BalancesController';
import { BalancesTracker as MultichainBalancesTracker } from './lib/accounts/BalancesTracker';
import { deferredPromise } from './lib/util';
import { METAMASK_COOKIE_HANDLER } from './constants/stream';
import MetaMaskController, {
ONE_KEY_VIA_TREZOR_MINOR_VERSION,
} from './metamask-controller';
Expand Down Expand Up @@ -1273,6 +1274,129 @@ describe('MetaMaskController', () => {
expect(mockKeyring.destroy).toHaveBeenCalledTimes(1);
});
});
describe('#setupPhishingCommunication', () => {
beforeEach(() => {
jest.spyOn(metamaskController, 'safelistPhishingDomain');
jest.spyOn(metamaskController, 'backToSafetyPhishingWarning');
metamaskController.preferencesController.setUsePhishDetect(true);
});
afterEach(() => {
jest.clearAllMocks();
});
it('creates a phishing stream with safelistPhishingDomain and backToSafetyPhishingWarning handler', async () => {
const safelistPhishingDomainRequest = {
name: 'metamask-phishing-safelist',
data: {
id: 1,
method: 'safelistPhishingDomain',
params: ['mockHostname'],
},
};
const backToSafetyPhishingWarningRequest = {
name: 'metamask-phishing-safelist',
data: { id: 2, method: 'backToSafetyPhishingWarning', params: [] },
};

const { promise, resolve } = deferredPromise();
const { promise: promiseStream, resolve: resolveStream } =
deferredPromise();
const streamTest = createThroughStream((chunk, _, cb) => {
if (chunk.name !== 'metamask-phishing-safelist') {
cb();
return;
}
resolve();
cb(null, chunk);
});

metamaskController.setupPhishingCommunication({
connectionStream: streamTest,
});

streamTest.write(safelistPhishingDomainRequest, null, () => {
expect(
metamaskController.safelistPhishingDomain,
).toHaveBeenCalledWith('mockHostname');
});
streamTest.write(backToSafetyPhishingWarningRequest, null, () => {
expect(
metamaskController.backToSafetyPhishingWarning,
).toHaveBeenCalled();
resolveStream();
});

await promise;
streamTest.end();
await promiseStream;
});
});

describe('#setUpCookieHandlerCommunication', () => {
let localMetaMaskController;
beforeEach(() => {
localMetaMaskController = new MetaMaskController({
showUserConfirmation: noop,
encryptor: mockEncryptor,
initState: {
...cloneDeep(firstTimeState),
MetaMetricsController: {
metaMetricsId: 'MOCK_METRICS_ID',
participateInMetaMetrics: true,
dataCollectionForMarketing: true,
},
},
initLangCode: 'en_US',
platform: {
showTransactionNotification: () => undefined,
getVersion: () => 'foo',
},
browser: browserPolyfillMock,
infuraProjectId: 'foo',
isFirstMetaMaskControllerSetup: true,
});
jest.spyOn(localMetaMaskController, 'getCookieFromMarketingPage');
});
afterEach(() => {
jest.clearAllMocks();
});
it('creates a cookie handler communication stream with getCookieFromMarketingPage handler', async () => {
const attributionRequest = {
name: METAMASK_COOKIE_HANDLER,
data: {
id: 1,
method: 'getCookieFromMarketingPage',
params: [{ ga_client_id: 'XYZ.ABC' }],
},
};

const { promise, resolve } = deferredPromise();
const { promise: promiseStream, resolve: resolveStream } =
deferredPromise();
const streamTest = createThroughStream((chunk, _, cb) => {
if (chunk.name !== METAMASK_COOKIE_HANDLER) {
cb();
return;
}
resolve();
cb(null, chunk);
});

localMetaMaskController.setUpCookieHandlerCommunication({
connectionStream: streamTest,
});

streamTest.write(attributionRequest, null, () => {
expect(
localMetaMaskController.getCookieFromMarketingPage,
).toHaveBeenCalledWith({ ga_client_id: 'XYZ.ABC' });
resolveStream();
});

await promise;
streamTest.end();
await promiseStream;
});
});

describe('#setupUntrustedCommunicationEip1193', () => {
const mockTxParams = { from: TEST_ADDRESS };
Expand Down

0 comments on commit 9eff241

Please sign in to comment.