test: add tests for metadata validation

Author: teresalves

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

@@ -22,6 +22,7 @@ import {
 	validatePutOptions,
 } from "./validator.worker";
 
+const MAX_BULK_GET_KEYS = 100;
 interface KVParams {
 	key: string;
 }
@@ -81,17 +82,22 @@ async function processKeyValue(
 	withMetadata: boolean = false
 ) {
 	const decoder = new TextDecoder();
-	let r = "";
+	let decodedValue = "";
 	if (obj?.value) {
 		for await (const chunk of obj?.value) {
-			r += decoder.decode(chunk, { stream: true });
+			decodedValue += decoder.decode(chunk, { stream: true });
 		}
-		r += decoder.decode();
+		decodedValue += decoder.decode();
 	}
 
 	let val = null;
 	try {
-		val = obj?.value == null ? null : type === "json" ? JSON.parse(r) : r;
+		val =
+			obj?.value == null
+				? null
+				: type === "json"
+					? JSON.parse(decodedValue)
+					: decodedValue;
 	} catch (err: any) {
 		throw new HttpError(
 			400,
@@ -104,7 +110,7 @@ async function processKeyValue(
 	if (withMetadata) {
 		return {
 			value: val,
-			metadata: obj?.metadata ? JSON.stringify(obj?.metadata) : null,
+			metadata: obj?.metadata ?? null,
 		};
 	}
 	return val;
@@ -121,20 +127,20 @@ export class KVNamespaceObject extends MiniflareDurableObject {
 	@POST("/bulk/get")
 	get: RouteHandler<KVParams> = async (req, params, url) => {
 		if (req.method === "POST" && req.body != null) {
-			let r = "";
+			let decodedBody = "";
 			const decoder = new TextDecoder();
 			for await (const chunk of req.body) {
-				r += decoder.decode(chunk, { stream: true });
+				decodedBody += decoder.decode(chunk, { stream: true });
 			}
-			r += decoder.decode();
-			const parsedBody = JSON.parse(r);
+			decodedBody += decoder.decode();
+			const parsedBody = JSON.parse(decodedBody);
 			const keys: string[] = parsedBody.keys;
 			const type = parsedBody?.type;
 			if (type && type !== "text" && type !== "json") {
 				return new Response("", { status: 400 });
 			}
 			const obj: { [key: string]: any } = {};
-			if (keys.length > 100) {
+			if (keys.length > MAX_BULK_GET_KEYS) {
 				return new Response("", { status: 400 });
 			}
 			for (const key of keys) {

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

@@ -172,6 +172,57 @@ test("bulk get: request json type", async (t) => {
 	}
 });
 
+test("bulk get: check metadata", async (t) => {
+	const { kv } = t.context;
+	await kv.put("key1", "value1", {
+		expiration: TIME_FUTURE,
+		metadata: { testing: true },
+	});
+
+	await kv.put("key2", "value2");
+	const result: any = await kv.getWithMetadata(["key1", "key2"]);
+	const expectedResult: any = new Map([
+		["key1", { value: "value1", metadata: { testing: true } }],
+		["key2", { value: "value2", metadata: null }],
+	]);
+	t.deepEqual(result, expectedResult);
+});
+
+test("bulk get: check metadata with int", async (t) => {
+	const { kv } = t.context;
+	await kv.put("key1", "value1", {
+		expiration: TIME_FUTURE,
+		metadata: 123,
+	});
+
+	const result: any = await kv.getWithMetadata(["key1"]);
+	const expectedResult: any = new Map([
+		["key1", { value: "value1", metadata: 123 }],
+	]);
+	t.deepEqual(result, expectedResult);
+});
+
+test("bulk get: check metadata as string", async (t) => {
+	const { kv } = t.context;
+	await kv.put("key1", "value1", {
+		expiration: TIME_FUTURE,
+		metadata: "example",
+	});
+	const result: any = await kv.getWithMetadata(["key1"]);
+	const expectedResult: any = new Map([
+		["key1", { value: "value1", metadata: "example" }],
+	]);
+	t.deepEqual(result, expectedResult);
+});
+
+test("bulk get: get with metadata for 404", async (t) => {
+	const { kv } = t.context;
+
+	const result: any = await kv.getWithMetadata(["key1"]);
+	const expectedResult: any = new Map([["key1", null]]);
+	t.deepEqual(result, expectedResult);
+});
+
 test("get: returns null for non-existent keys", async (t) => {
 	const { kv } = t.context;
 	t.is(await kv.get("key"), null);

packages/miniflare/test/test-shared/miniflare.ts

@@ -44,6 +44,8 @@ export function namespace<T>(ns: string, binding: T): Namespaced<T> {
 					);
 					if (result instanceof Promise) {
 						return result.then((res) => {
+							// KV.get([a,b,c]) would be prefixed with ns, so we strip this prefix from response.
+							// Map keys => [ns-a, ns-b, ns-c] -> [a,b,c]
 							if (res instanceof Map) {
 								const newResult = new Map<string, unknown>();
 								for (const [key, value] of res) {