Skip to content

fix: reject non-finite retry policy values #274

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

Open
YunchuWang wants to merge 1 commit into
base: main
Choose a base branch
from
+125 −16
Open

fix: reject non-finite retry policy values #274

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
22 changes: 12 additions & 10 deletions packages/durabletask-js/src/task/retry/retry-policy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,32 +65,34 @@ export class RetryPolicy {
} = options;

// Validation aligned with .NET SDK
if (maxNumberOfAttempts <= 0) {
throw new Error("maxNumberOfAttempts must be greater than zero");
// Use !Number.isFinite() guards to reject NaN and Infinity, which bypass
// comparison operators silently (e.g. NaN <= 0 is false).
if (!Number.isFinite(maxNumberOfAttempts) || maxNumberOfAttempts <= 0) {
throw new Error("maxNumberOfAttempts must be a finite number greater than zero");
}

if (firstRetryIntervalInMilliseconds <= 0) {
throw new Error("firstRetryIntervalInMilliseconds must be greater than zero");
if (!Number.isFinite(firstRetryIntervalInMilliseconds) || firstRetryIntervalInMilliseconds <= 0) {
throw new Error("firstRetryIntervalInMilliseconds must be a finite number greater than zero");
}

if (backoffCoefficient < 1.0) {
throw new Error("backoffCoefficient must be greater than or equal to 1.0");
if (!Number.isFinite(backoffCoefficient) || backoffCoefficient < 1.0) {
throw new Error("backoffCoefficient must be a finite number greater than or equal to 1.0");
}

if (
maxRetryIntervalInMilliseconds !== undefined &&
maxRetryIntervalInMilliseconds !== -1 &&
maxRetryIntervalInMilliseconds < firstRetryIntervalInMilliseconds
(!Number.isFinite(maxRetryIntervalInMilliseconds) || maxRetryIntervalInMilliseconds < firstRetryIntervalInMilliseconds)
) {
Comment on lines 82 to 86
throw new Error("maxRetryIntervalInMilliseconds must be greater than or equal to firstRetryIntervalInMilliseconds");
throw new Error("maxRetryIntervalInMilliseconds must be a finite number greater than or equal to firstRetryIntervalInMilliseconds");
}

if (
retryTimeoutInMilliseconds !== undefined &&
retryTimeoutInMilliseconds !== -1 &&
retryTimeoutInMilliseconds < firstRetryIntervalInMilliseconds
(!Number.isFinite(retryTimeoutInMilliseconds) || retryTimeoutInMilliseconds < firstRetryIntervalInMilliseconds)
) {
throw new Error("retryTimeoutInMilliseconds must be greater than or equal to firstRetryIntervalInMilliseconds");
throw new Error("retryTimeoutInMilliseconds must be a finite number greater than or equal to firstRetryIntervalInMilliseconds");
}

this._maxNumberOfAttempts = maxNumberOfAttempts;
Expand Down
119 changes: 113 additions & 6 deletions packages/durabletask-js/test/retry-policy.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ describe("RetryPolicy", () => {
maxNumberOfAttempts: 0,
firstRetryIntervalInMilliseconds: 1000,
});
}).toThrow("maxNumberOfAttempts must be greater than zero");
}).toThrow("maxNumberOfAttempts must be a finite number greater than zero");
});

it("should throw error when firstRetryIntervalInMilliseconds is zero", () => {
Expand All @@ -55,7 +55,7 @@ describe("RetryPolicy", () => {
maxNumberOfAttempts: 3,
firstRetryIntervalInMilliseconds: 0,
});
}).toThrow("firstRetryIntervalInMilliseconds must be greater than zero");
}).toThrow("firstRetryIntervalInMilliseconds must be a finite number greater than zero");
});

it("should throw error when firstRetryIntervalInMilliseconds is negative", () => {
Expand All @@ -65,7 +65,7 @@ describe("RetryPolicy", () => {
maxNumberOfAttempts: 3,
firstRetryIntervalInMilliseconds: -100,
});
}).toThrow("firstRetryIntervalInMilliseconds must be greater than zero");
}).toThrow("firstRetryIntervalInMilliseconds must be a finite number greater than zero");
});

it("should throw error when backoffCoefficient is less than 1.0", () => {
Expand All @@ -76,7 +76,7 @@ describe("RetryPolicy", () => {
firstRetryIntervalInMilliseconds: 1000,
backoffCoefficient: 0.5,
});
}).toThrow("backoffCoefficient must be greater than or equal to 1.0");
}).toThrow("backoffCoefficient must be a finite number greater than or equal to 1.0");
});

it("should throw error when maxRetryIntervalInMilliseconds is less than firstRetryInterval", () => {
Expand All @@ -87,7 +87,7 @@ describe("RetryPolicy", () => {
firstRetryIntervalInMilliseconds: 1000,
maxRetryIntervalInMilliseconds: 500,
});
}).toThrow("maxRetryIntervalInMilliseconds must be greater than or equal to firstRetryIntervalInMilliseconds");
}).toThrow("maxRetryIntervalInMilliseconds must be a finite number greater than or equal to firstRetryIntervalInMilliseconds");
});

it("should throw error when retryTimeoutInMilliseconds is less than firstRetryInterval", () => {
Expand All @@ -98,7 +98,114 @@ describe("RetryPolicy", () => {
firstRetryIntervalInMilliseconds: 1000,
retryTimeoutInMilliseconds: 500,
});
}).toThrow("retryTimeoutInMilliseconds must be greater than or equal to firstRetryIntervalInMilliseconds");
}).toThrow("retryTimeoutInMilliseconds must be a finite number greater than or equal to firstRetryIntervalInMilliseconds");
});

describe("NaN and Infinity rejection", () => {
it("should throw error when maxNumberOfAttempts is NaN", () => {
expect(() => {
new RetryPolicy({
maxNumberOfAttempts: NaN,
firstRetryIntervalInMilliseconds: 1000,
});
}).toThrow("maxNumberOfAttempts must be a finite number greater than zero");
});

it("should throw error when maxNumberOfAttempts is Infinity", () => {
expect(() => {
new RetryPolicy({
maxNumberOfAttempts: Infinity,
firstRetryIntervalInMilliseconds: 1000,
});
}).toThrow("maxNumberOfAttempts must be a finite number greater than zero");
});

it("should throw error when firstRetryIntervalInMilliseconds is NaN", () => {
expect(() => {
new RetryPolicy({
maxNumberOfAttempts: 3,
firstRetryIntervalInMilliseconds: NaN,
});
}).toThrow("firstRetryIntervalInMilliseconds must be a finite number greater than zero");
});

it("should throw error when firstRetryIntervalInMilliseconds is Infinity", () => {
expect(() => {
new RetryPolicy({
maxNumberOfAttempts: 3,
firstRetryIntervalInMilliseconds: Infinity,
});
}).toThrow("firstRetryIntervalInMilliseconds must be a finite number greater than zero");
});

it("should throw error when backoffCoefficient is NaN", () => {
expect(() => {
new RetryPolicy({
maxNumberOfAttempts: 3,
firstRetryIntervalInMilliseconds: 1000,
backoffCoefficient: NaN,
});
}).toThrow("backoffCoefficient must be a finite number greater than or equal to 1.0");
});

it("should throw error when backoffCoefficient is Infinity", () => {
expect(() => {
new RetryPolicy({
maxNumberOfAttempts: 3,
firstRetryIntervalInMilliseconds: 1000,
backoffCoefficient: Infinity,
});
}).toThrow("backoffCoefficient must be a finite number greater than or equal to 1.0");
});

it("should throw error when maxRetryIntervalInMilliseconds is NaN", () => {
expect(() => {
new RetryPolicy({
maxNumberOfAttempts: 3,
firstRetryIntervalInMilliseconds: 1000,
maxRetryIntervalInMilliseconds: NaN,
});
}).toThrow("maxRetryIntervalInMilliseconds must be a finite number greater than or equal to firstRetryIntervalInMilliseconds");
});

it("should throw error when maxRetryIntervalInMilliseconds is Infinity", () => {
expect(() => {
new RetryPolicy({
maxNumberOfAttempts: 3,
firstRetryIntervalInMilliseconds: 1000,
maxRetryIntervalInMilliseconds: Infinity,
});
}).toThrow("maxRetryIntervalInMilliseconds must be a finite number greater than or equal to firstRetryIntervalInMilliseconds");
});

it("should throw error when retryTimeoutInMilliseconds is NaN", () => {
expect(() => {
new RetryPolicy({
maxNumberOfAttempts: 3,
firstRetryIntervalInMilliseconds: 1000,
retryTimeoutInMilliseconds: NaN,
});
}).toThrow("retryTimeoutInMilliseconds must be a finite number greater than or equal to firstRetryIntervalInMilliseconds");
});

it("should throw error when retryTimeoutInMilliseconds is Infinity", () => {
expect(() => {
new RetryPolicy({
maxNumberOfAttempts: 3,
firstRetryIntervalInMilliseconds: 1000,
retryTimeoutInMilliseconds: Infinity,
});
}).toThrow("retryTimeoutInMilliseconds must be a finite number greater than or equal to firstRetryIntervalInMilliseconds");
});

it("should throw error when maxNumberOfAttempts is negative Infinity", () => {
expect(() => {
new RetryPolicy({
maxNumberOfAttempts: -Infinity,
firstRetryIntervalInMilliseconds: 1000,
});
}).toThrow("maxNumberOfAttempts must be a finite number greater than zero");
});
});

it("should accept exactly 1.0 as backoffCoefficient", () => {
Expand Down
Loading