Skip to content

fix: respect retries from retryfailedstep plugin in helpers #4028

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 29, 2023
Merged

fix: respect retries from retryfailedstep plugin in helpers #4028

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/helper/Playwright.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -474,7 +474,7 @@ class Playwright extends Helper {
async _before(test) {
this.currentRunningTest = test;
recorder.retry({
retries: 5,
retries: process.env.FAILED_STEP_RETIRES || 3,
when: err => {
if (!err || typeof (err.message) !== 'string') {
return false;
Expand Down
2 changes: 1 addition & 1 deletion lib/helper/Puppeteer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ class Puppeteer extends Helper {
this.sessionPages = {};
this.currentRunningTest = test;
recorder.retry({
retries: 3,
retries: process.env.FAILED_STEP_RETIRES || 3,
when: err => {
if (!err || typeof (err.message) !== 'string') {
return false;
Expand Down
2 changes: 2 additions & 0 deletions lib/plugin/retryFailedStep.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,8 @@ module.exports = (config) => {

event.dispatcher.on(event.test.before, (test) => {
if (test && test.disableRetryFailedStep) return; // disable retry when a test is not active
// this env var is used to set the retries inside _before() block of helpers
process.env.FAILED_STEP_RETIRES = config.retries;
recorder.retry(config);
});
};
22 changes: 12 additions & 10 deletions test/unit/plugin/retryFailedStep_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ describe('retryFailedStep', () => {
}, undefined, undefined, true);
return recorder.promise();
});

it('should not retry within', async () => {
retryFailedStep({ retries: 1, minTimeout: 1 });
event.dispatcher.emit(event.test.before, {});
Expand All @@ -51,9 +52,10 @@ describe('retryFailedStep', () => {
});
await recorder.promise();
} catch (e) {
recorder.catchWithoutStop((err) => err);
await recorder.catchWithoutStop((err) => err);
}

expect(process.env.FAILED_STEP_RETIRES).to.equal('1');
// expects to retry only once
counter.should.equal(2);
});
Expand All @@ -65,15 +67,15 @@ describe('retryFailedStep', () => {
let counter = 0;
event.dispatcher.emit(event.step.started, { name: 'waitForElement' });
try {
recorder.add(() => {
await recorder.add(() => {
counter++;
if (counter < 3) {
throw new Error();
}
}, undefined, undefined, true);
await recorder.promise();
} catch (e) {
recorder.catchWithoutStop((err) => err);
await recorder.catchWithoutStop((err) => err);
}

expect(counter).to.equal(1);
Expand All @@ -87,15 +89,15 @@ describe('retryFailedStep', () => {
let counter = 0;
event.dispatcher.emit(event.step.started, { name: 'amOnPage' });
try {
recorder.add(() => {
await recorder.add(() => {
counter++;
if (counter < 3) {
throw new Error();
}
}, undefined, undefined, true);
await recorder.promise();
} catch (e) {
recorder.catchWithoutStop((err) => err);
await recorder.catchWithoutStop((err) => err);
}

expect(counter).to.equal(1);
Expand All @@ -109,15 +111,15 @@ describe('retryFailedStep', () => {
let counter = 0;
event.dispatcher.emit(event.step.started, { name: 'somethingNew' });
try {
recorder.add(() => {
await recorder.add(() => {
counter++;
if (counter < 3) {
throw new Error();
}
}, undefined, undefined, true);
await recorder.promise();
} catch (e) {
recorder.catchWithoutStop((err) => err);
await recorder.catchWithoutStop((err) => err);
}

expect(counter).to.equal(1);
Expand All @@ -131,15 +133,15 @@ describe('retryFailedStep', () => {
let counter = 0;
event.dispatcher.emit(event.step.started, { name: 'somethingNew' });
try {
recorder.add(() => {
await recorder.add(() => {
counter++;
if (counter < 3) {
throw new Error();
}
}, undefined, undefined, true);
await recorder.promise();
} catch (e) {
recorder.catchWithoutStop((err) => err);
await recorder.catchWithoutStop((err) => err);
}

expect(counter).to.equal(1);
Expand All @@ -161,7 +163,7 @@ describe('retryFailedStep', () => {
});
await recorder.promise();
} catch (e) {
recorder.catchWithoutStop((err) => err);
await recorder.catchWithoutStop((err) => err);
}

// expects to retry only once
Expand Down