feat: Allow min 30s cache TTL in miniflare KV plugin (#11391)

* feat: Change Miniflare to allow lower than 60 seconds cache TTL in the KV plugin

* chore: Refactored KV constants to include unit prefix

* chore: Updated change to patch

Author: pmiguel

.changeset/gold-ties-enjoy.md

@@ -0,0 +1,5 @@
+---
+"miniflare": patch
+---
+
+Set minimum KV Cache TTL in Miniflare to 30 seconds

packages/miniflare/src/workers/kv/constants.ts

@@ -1,13 +1,14 @@
 import { MatcherRegExps, testRegExps } from "miniflare:shared";
 
 export const KVLimits = {
-	MIN_CACHE_TTL: 60 /* 60s */,
+	MIN_CACHE_TTL_SECONDS: 30,
+	MIN_EXPIRATION_TTL_SECONDS: 60,
 	MAX_LIST_KEYS: 1000,
-	MAX_KEY_SIZE: 512 /* 512B */,
-	MAX_VALUE_SIZE: 25 * 1024 * 1024 /* 25MiB */,
-	MAX_VALUE_SIZE_TEST: 1024 /* 1KiB */,
-	MAX_METADATA_SIZE: 1024 /* 1KiB */,
-	MAX_BULK_SIZE: 25 * 1024 * 1024 /* 25MiB */,
+	MAX_KEY_SIZE_BYTES: 512,
+	MAX_VALUE_SIZE_BYTES: 25 * 1024 * 1024 /* 25MiB */,
+	MAX_VALUE_SIZE_TEST_BYTES: 1024 /* 1KiB */,
+	MAX_METADATA_SIZE_BYTES: 1024 /* 1KiB */,
+	MAX_BULK_SIZE_BYTES: 25 * 1024 * 1024 /* 25MiB */,
 } as const;
 
 export const KVParams = {

packages/miniflare/src/workers/kv/namespace.worker.ts

@@ -161,8 +161,8 @@ export class KVNamespaceObject extends MiniflareDurableObject {
 				obj[key] = value;
 			}
 			const maxValueSize = this.beingTested
-				? KVLimits.MAX_VALUE_SIZE_TEST
-				: KVLimits.MAX_BULK_SIZE;
+				? KVLimits.MAX_VALUE_SIZE_TEST_BYTES
+				: KVLimits.MAX_BULK_SIZE_BYTES;
 			if (totalBytes > maxValueSize) {
 				throw new HttpError(
 					413,
@@ -233,8 +233,8 @@ export class KVNamespaceObject extends MiniflareDurableObject {
 		});
 
 		const maxValueSize = this.beingTested
-			? KVLimits.MAX_VALUE_SIZE_TEST
-			: KVLimits.MAX_VALUE_SIZE;
+			? KVLimits.MAX_VALUE_SIZE_TEST_BYTES
+			: KVLimits.MAX_VALUE_SIZE_BYTES;
 		let maxLengthStream: MaxLengthStream | undefined;
 		if (valueLengthHint !== undefined && valueLengthHint > maxValueSize) {
 			// If we know the size of the value (i.e. from `Content-Length`) use that

packages/miniflare/src/workers/kv/validator.worker.ts

@@ -30,10 +30,10 @@ export function validateKey(key: string): void {
 
 export function validateKeyLength(key: string): void {
 	const keyLength = Buffer.byteLength(key);
-	if (keyLength > KVLimits.MAX_KEY_SIZE) {
+	if (keyLength > KVLimits.MAX_KEY_SIZE_BYTES) {
 		throw new HttpError(
 			414,
-			`UTF-8 encoded length of ${keyLength} exceeds key length limit of ${KVLimits.MAX_KEY_SIZE}.`
+			`UTF-8 encoded length of ${keyLength} exceeds key length limit of ${KVLimits.MAX_KEY_SIZE_BYTES}.`
 		);
 	}
 }
@@ -48,11 +48,11 @@ export function validateGetOptions(
 	const cacheTtl = options?.cacheTtl;
 	if (
 		cacheTtl !== undefined &&
-		(isNaN(cacheTtl) || cacheTtl < KVLimits.MIN_CACHE_TTL)
+		(isNaN(cacheTtl) || cacheTtl < KVLimits.MIN_CACHE_TTL_SECONDS)
 	) {
 		throw new HttpError(
 			400,
-			`Invalid ${KVParams.CACHE_TTL} of ${cacheTtl}. Cache TTL must be at least ${KVLimits.MIN_CACHE_TTL}.`
+			`Invalid ${KVParams.CACHE_TTL} of ${cacheTtl}. Cache TTL must be at least ${KVLimits.MIN_CACHE_TTL_SECONDS}.`
 		);
 	}
 }
@@ -80,10 +80,10 @@ export function validatePutOptions(
 				`Invalid ${KVParams.EXPIRATION_TTL} of ${rawExpirationTtl}. Please specify integer greater than 0.`
 			);
 		}
-		if (expirationTtl < KVLimits.MIN_CACHE_TTL) {
+		if (expirationTtl < KVLimits.MIN_EXPIRATION_TTL_SECONDS) {
 			throw new HttpError(
 				400,
-				`Invalid ${KVParams.EXPIRATION_TTL} of ${rawExpirationTtl}. Expiration TTL must be at least ${KVLimits.MIN_CACHE_TTL}.`
+				`Invalid ${KVParams.EXPIRATION_TTL} of ${rawExpirationTtl}. Expiration TTL must be at least ${KVLimits.MIN_EXPIRATION_TTL_SECONDS}.`
 			);
 		}
 		expiration = now + expirationTtl;
@@ -95,10 +95,10 @@ export function validatePutOptions(
 				`Invalid ${KVParams.EXPIRATION} of ${rawExpiration}. Please specify integer greater than the current number of seconds since the UNIX epoch.`
 			);
 		}
-		if (expiration < now + KVLimits.MIN_CACHE_TTL) {
+		if (expiration < now + KVLimits.MIN_EXPIRATION_TTL_SECONDS) {
 			throw new HttpError(
 				400,
-				`Invalid ${KVParams.EXPIRATION} of ${rawExpiration}. Expiration times must be at least ${KVLimits.MIN_CACHE_TTL} seconds in the future.`
+				`Invalid ${KVParams.EXPIRATION} of ${rawExpiration}. Expiration times must be at least ${KVLimits.MIN_EXPIRATION_TTL_SECONDS} seconds in the future.`
 			);
 		}
 	}
@@ -107,10 +107,10 @@ export function validatePutOptions(
 	let metadata: unknown | undefined;
 	if (rawMetadata !== null) {
 		const metadataLength = Buffer.byteLength(rawMetadata);
-		if (metadataLength > KVLimits.MAX_METADATA_SIZE) {
+		if (metadataLength > KVLimits.MAX_METADATA_SIZE_BYTES) {
 			throw new HttpError(
 				413,
-				`Metadata length of ${metadataLength} exceeds limit of ${KVLimits.MAX_METADATA_SIZE}.`
+				`Metadata length of ${metadataLength} exceeds limit of ${KVLimits.MAX_METADATA_SIZE_BYTES}.`
 			);
 		}
 		metadata = JSON.parse(rawMetadata);

packages/miniflare/test/plugins/kv/index.spec.ts

@@ -283,13 +283,14 @@ test("get: validates but ignores cache ttl", async (t) => {
 	await t.throwsAsync(kv.get("key", { cacheTtl: "not a number" as any }), {
 		instanceOf: Error,
 		message:
-			"KV GET failed: 400 Invalid cache_ttl of 0. Cache TTL must be at least 60.",
+			"KV GET failed: 400 Invalid cache_ttl of 0. Cache TTL must be at least 30.",
 	});
 	await t.throwsAsync(kv.get("key", { cacheTtl: 10 }), {
 		instanceOf: Error,
 		message:
-			"KV GET failed: 400 Invalid cache_ttl of 10. Cache TTL must be at least 60.",
+			"KV GET failed: 400 Invalid cache_ttl of 10. Cache TTL must be at least 30.",
 	});
+	t.not(await kv.get("key", { cacheTtl: 30 }), undefined);
 	t.not(await kv.get("key", { cacheTtl: 60 }), undefined);
 });