Skip to content

Commit

Permalink
test: Fixed artifacts issue due to switching window title (#28469)
Browse files Browse the repository at this point in the history
<!--
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**

This PR addresses the issue where artifacts are not generated when a
timeout occurs during the switching window and the dialog does not
appear, making it difficult to determine what has happened during the
test scenario.

The fix ensures that an error is generated when a timeout occurs and is
correctly returned. If the dialog is found, no error is generated.
Special thanks to @davidmurdoch for pair programming, understanding the
issue and suggesting the fix.

<!--
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/28469?quickstart=1)

## **Related issues**

Fixes:
#28116

## **Manual testing steps**

All the artifacts needs to be generated.

## **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**

- [x] 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).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] 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
hjetpoluru authored Nov 21, 2024
1 parent 175d429 commit e748576
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
18 changes: 15 additions & 3 deletions test/e2e/background-socket/server-mocha-to-background.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,14 @@ class ServerMochaToBackground {
if (message.command === 'openTabs' && message.tabs) {
this.eventEmitter.emit('openTabs', message.tabs);
} else if (message.command === 'notFound') {
throw new Error(
const error = new Error(
`No window found by background script with ${message.property}: ${message.value}`,
);
if (this.eventEmitter.listenerCount('error') > 0) {
this.eventEmitter.emit('error', error);
} else {
throw error;
}
}
}

Expand All @@ -108,8 +113,15 @@ class ServerMochaToBackground {

// This is a way to wait for an event async, without timeouts or polling
async waitForResponse() {
return new Promise((resolve) => {
this.eventEmitter.once('openTabs', resolve);
return new Promise((resolve, reject) => {
this.eventEmitter.once('error', (error) => {
this.eventEmitter.removeListener('openTabs', resolve);
reject(error);
});
this.eventEmitter.once('openTabs', (result) => {
this.eventEmitter.removeListener('error', reject);
resolve(result);
});
});
}
}
Expand Down
1 change: 1 addition & 0 deletions test/e2e/background-socket/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ export type Handle = {
export type WindowProperties = 'title' | 'url';

export type ServerMochaEventEmitterType = {
error: [error: Error];
openTabs: [openTabs: chrome.tabs.Tab[]];
notFound: [openTabs: chrome.tabs.Tab[]];
};

0 comments on commit e748576

Please sign in to comment.