Skip to content

Add global query retry options setting #76

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
pwrightcertinia merged 2 commits into from
Dec 10, 2024
Merged

Add global query retry options setting #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
21bdeb7
feat: add method to set global retry options on queries
pwrightcertinia Dec 10, 2024
306e6be
chore: update changelog and version
pwrightcertinia Dec 10, 2024
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# test-runner - Changelog

## 3.2.0 - 2024-12-10

* Add `QueryHelper.setGlobalRetryOptions()` static method.
* Use to change the retry behaviour of queries across all instances.

## 3.1.3 - 2024-11-20

* Exclude `@testSetup` methods from `ApexTestResult` queries.
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@apexdevtools/test-runner",
"version": "3.1.3",
"version": "3.2.0",
"description": "Apex parallel test runner with reliability goodness",
"author": {
"name": "Apex Dev Tools Team",
Expand Down
13 changes: 11 additions & 2 deletions src/query/QueryHelper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ export class QueryHelper {
retryConfig: { delay?: number; retries?: number };
logger?: Logger;

private static globalOptions?: QueryOptions;

static setGlobalRetryOptions(opts?: QueryOptions) {
QueryHelper.globalOptions = opts;
}

static instance(
connection: Connection,
logger?: Logger,
Expand All @@ -37,8 +43,11 @@ export class QueryHelper {
) {
this.connection = connection;
this.retryConfig = {
retries: options.maxQueryRetries,
delay: options.queryInitialIntervalMs,
retries:
options.maxQueryRetries || QueryHelper.globalOptions?.maxQueryRetries,
delay:
options.queryInitialIntervalMs ||
QueryHelper.globalOptions?.queryInitialIntervalMs,
};
this.logger = logger;
}
Expand Down
37 changes: 37 additions & 0 deletions test/query/QueryHelper.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ describe('QueryHelper', () => {

afterEach(() => {
sandbox.restore();
QueryHelper.setGlobalRetryOptions(undefined);
});

it('should retry with default options', async () => {
Expand Down Expand Up @@ -105,6 +106,42 @@ describe('QueryHelper', () => {
);
});

it('should retry with custom global options', async () => {
queryMock.execute.resolves([]);
queryMock.execute.onFirstCall().rejects(new Error('error'));
queryMock.execute.onSecondCall().rejects(new Error('400'));

const logger = new CapturingLogger();

QueryHelper.setGlobalRetryOptions({
maxQueryRetries: 2,
queryInitialIntervalMs: 500,
});

await QueryHelper.instance(mockConnection, logger).query(
'sobject',
'clause',
'fields'
);

expect(queryMock.execute.callCount).to.equal(3);
expect(sobjectStub.alwaysCalledWith('sobject')).to.be.true;
expect(sobjectMock.find.alwaysCalledWith('clause', 'fields')).to.be.true;
expect(logger.entries.length).to.equal(4);
expect(logger.entries[0]).to.match(
logRegex('Warning: Request failed. Cause: error')
);
expect(logger.entries[1]).to.match(
logRegex('Waiting 0.5 seconds to retry \\(attempts: 1\\)')
);
expect(logger.entries[2]).to.match(
logRegex('Warning: Request failed. Cause: 400')
);
expect(logger.entries[3]).to.match(
logRegex('Waiting 1 seconds to retry \\(attempts: 2\\)')
);
});

it('should throw error after max retries', async () => {
const error = new Error('400');
queryMock.execute.rejects(error);
Expand Down
Loading