cache-manager - fix: read raw entries with getRaw() for Keyv 6 stores

packages/cache-manager/package.json

@@ -71,6 +71,7 @@
     "@keyv/redis": "^5.1.6",
     "cache-manager-redis-yet": "^5.1.5",
     "cacheable": "workspace:^",
+    "keyv6": "npm:keyv@^6.1.0",
     "tsdown": "^0.23.0",
     "typescript": "^7.0.2"
   }

packages/cache-manager/src/index.ts

@@ -185,7 +185,7 @@ export const createCache = (options?: CreateCacheOptions): Cache => {
 		if (nonBlocking) {
 			try {
 				result = await Promise.race(
-					stores.map(async (store) => store.get(key, { raw: true })),
+					stores.map(async (store) => store.getRaw(key)),
 				);
 				if (result === undefined) {
 					return undefined;
@@ -196,7 +196,7 @@ export const createCache = (options?: CreateCacheOptions): Cache => {
 		} else {
 			for (const store of stores) {
 				try {
-					const cacheValue = await store.get(key, { raw: true });
+					const cacheValue = await store.getRaw(key);
 					if (cacheValue !== undefined) {
 						result = cacheValue;
 						eventEmitter.emit("ttl", { key, value: result });
@@ -349,7 +349,7 @@ export const createCache = (options?: CreateCacheOptions): Cache => {
 
 			for (; i < stores.length; i++) {
 				try {
-					const data = await stores[i].get<T>(key, { raw: true });
+					const data = await stores[i].getRaw<T>(key);
 					if (data !== undefined) {
 						value = data.value;
 						rawData = data;

packages/cache-manager/test/keyv6.test.ts

@@ -0,0 +1,30 @@
+import { faker } from "@faker-js/faker";
+import type { Keyv } from "keyv";
+import { Keyv as Keyv6 } from "keyv6";
+import { describe, expect, it, vi } from "vitest";
+import { createCache } from "../src/index.js";
+
+describe("Keyv 6 store", () => {
+	const ttl = 1000;
+	// The `stores` option has the Keyv 5 type, so a Keyv 6 instance needs a cast.
+	const createKeyv6Cache = () =>
+		createCache({ stores: [new Keyv6() as unknown as Keyv] });
+
+	it("wrap returns the cached value", async () => {
+		const cache = createKeyv6Cache();
+		const key = faker.string.alpha(20);
+		const getValue = vi.fn(() => ({ id: 1 }));
+
+		await cache.wrap(key, getValue, ttl);
+		await expect(cache.wrap(key, getValue, ttl)).resolves.toEqual({ id: 1 });
+		expect(getValue).toBeCalledTimes(1);
+	});
+
+	it("ttl returns the expiration", async () => {
+		const cache = createKeyv6Cache();
+		const key = faker.string.alpha(20);
+
+		await cache.set(key, faker.string.sample(), ttl);
+		await expect(cache.ttl(key)).resolves.toBeGreaterThan(Date.now());
+	});
+});

packages/cache-manager/test/multiple-stores.test.ts

@@ -70,7 +70,7 @@ describe("multiple stores", () => {
 		await expect(keyv2.get(data.key)).resolves.toEqual(data.value);
 
 		// Store 1 get error
-		keyv1.get = () => {
+		keyv1.getRaw = () => {
 			throw new Error("store 1 get error");
 		};
 
@@ -92,20 +92,20 @@ describe("multiple stores", () => {
 		await expect(keyv2.get(data.key)).resolves.toEqual(data.value);
 
 		// Store 1 get error
-		const getOk = keyv1.get;
+		const getOk = keyv1.getRaw;
 		const getError = () => {
 			throw new Error("store 1 get error");
 		};
 
-		keyv1.get = getError;
+		keyv1.getRaw = getError;
 
 		await sleep(ttl - refreshThreshold + 100);
 
 		await expect(
 			cache.wrap(data.key, () => "new", ttl, refreshThreshold),
 		).resolves.toEqual(data.value);
 
-		keyv1.get = getOk;
+		keyv1.getRaw = getOk;
 		// Store 1 has been updated the latest value
 		await expect(keyv1.get(data.key)).resolves.toEqual("new");
 		await expect(cache.wrap(data.key, () => "latest", ttl)).resolves.toEqual(

packages/cache-manager/test/ttl.test.ts

@@ -31,15 +31,15 @@ describe("get", () => {
 
 	it("error", async () => {
 		await cache.set(data.key, data.value);
-		keyv.get = () => {
+		keyv.getRaw = () => {
 			throw new Error("get error");
 		};
 
 		await expect(cache.ttl(data.key)).resolves.toBeUndefined();
 	});
 	it("error on non-blocking enabled", async () => {
 		const secondKeyv = new Keyv();
-		keyv.get = () => {
+		keyv.getRaw = () => {
 			throw new Error("get error");
 		};
 

packages/cache-manager/test/wrap.test.ts

@@ -247,7 +247,7 @@ describe("wrap", () => {
 
 	it("store get failed", async () => {
 		const getValue = vi.fn(() => data.value);
-		keyv.get = () => {
+		keyv.getRaw = () => {
 			throw new Error("get failed");
 		};