Skip to content
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

Jump to bottom

Throw an error for KV expirations above the maximum 32-bit signed integer #487

Merged
merged 5 commits into from
Feb 7, 2023
Merged

Throw an error for KV expirations above the maximum 32-bit signed integer #487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ff64897
Update valid bounds for KV expirations
huw Feb 1, 2023
97cd031
Extract MAX_EXPIRATION
huw Feb 2, 2023
5b4708d
Add tests
huw Feb 2, 2023
63c7ea0
Exactly match Cloudflare's errors
huw Feb 3, 2023
a153bf4
Correctly throw when the expiration is below the lower bound
huw Feb 3, 2023
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
14 changes: 14 additions & 0 deletions packages/kv/src/namespace.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ import {
} from "@miniflare/shared";

const MIN_CACHE_TTL = 60; /* 60s */
const MIN_EXPIRATION = -2147483648; /* Minimum signed 32-bit integer */
const MAX_EXPIRATION = 2147483647; /* Maximum signed 32-bit integer */
const MAX_LIST_KEYS = 1000;
const MAX_KEY_SIZE = 512; /* 512B */
const MAX_VALUE_SIZE = 25 * 1024 * 1024; /* 25MiB */
Expand Down Expand Up @@ -289,6 +291,12 @@ export class KVNamespace {
let expiration = normaliseInt(options.expiration);
const expirationTtl = normaliseInt(options.expirationTtl);
if (expirationTtl !== undefined) {
if (expirationTtl < MIN_EXPIRATION || expirationTtl > MAX_EXPIRATION) {
// Workers throws like this without the extra sugar when the value is out of bounds, and throws before checking the value itself.
throw new TypeError(
`Value out of range. Must be between ${MIN_EXPIRATION} and ${MAX_EXPIRATION} (inclusive).`
);
}
if (isNaN(expirationTtl) || expirationTtl <= 0) {
throwKVError(
"PUT",
Expand All @@ -305,6 +313,12 @@ export class KVNamespace {
}
expiration = now + expirationTtl;
} else if (expiration !== undefined) {
if (expiration < MIN_EXPIRATION || expiration > MAX_EXPIRATION) {
// Workers throws like this without the extra sugar when the value is out of bounds, and throws before checking the value itself.
throw new TypeError(
`Value out of range. Must be between ${MIN_EXPIRATION} and ${MAX_EXPIRATION} (inclusive).`
);
}
if (isNaN(expiration) || expiration <= now) {
throwKVError(
"PUT",
Expand Down
20 changes: 20 additions & 0 deletions packages/kv/test/namespace.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -467,6 +467,16 @@ test("put: validates expiration ttl", async (t) => {
message:
"KV PUT failed: 400 Invalid expiration_ttl of 30. Expiration TTL must be at least 60.",
});
await t.throwsAsync(ns.put("key", "value", { expirationTtl: 2147483648 }), {
instanceOf: TypeError,
message:
"Value out of range. Must be between -2147483648 and 2147483647 (inclusive).",
});
await t.throwsAsync(ns.put("key", "value", { expirationTtl: -2147483649 }), {
instanceOf: TypeError,
message:
"Value out of range. Must be between -2147483648 and 2147483647 (inclusive).",
});
});
test("put: validates expiration", async (t) => {
const { ns } = t.context;
Expand All @@ -486,6 +496,16 @@ test("put: validates expiration", async (t) => {
message:
"KV PUT failed: 400 Invalid expiration of 780. Expiration times must be at least 60 seconds in the future.",
});
await t.throwsAsync(ns.put("key", "value", { expiration: 2147483648 }), {
instanceOf: TypeError,
message:
"Value out of range. Must be between -2147483648 and 2147483647 (inclusive).",
});
await t.throwsAsync(ns.put("key", "value", { expiration: -2147483649 }), {
instanceOf: TypeError,
message:
"Value out of range. Must be between -2147483648 and 2147483647 (inclusive).",
});
});
test("put: validates value size", async (t) => {
const { ns } = t.context;
Expand Down