utils - fix: adding in keyv instance (#1377)

Author: jaredwray

packages/utils/src/is-keyv-instance.ts

@@ -2,6 +2,11 @@ import { Keyv } from "keyv";
 
 // biome-ignore lint/suspicious/noExplicitAny: type format
 export function isKeyvInstance(keyv: any): boolean {
+	// Check if keyv is null or undefined
+	if (keyv === null || keyv === undefined) {
+		return false;
+	}
+
 	// Check if the object is an instance of Keyv
 	if (keyv instanceof Keyv) {
 		return true;

packages/utils/test/is-keyv-instance.test.ts

@@ -0,0 +1,106 @@
+import { Keyv } from "keyv";
+import { describe, expect, test } from "vitest";
+import { isKeyvInstance } from "../src/is-keyv-instance.js";
+
+describe("isKeyvInstance", () => {
+	test("returns true for actual Keyv instance", () => {
+		// Arrange
+		const keyv = new Keyv();
+
+		// Act & Assert
+		expect(isKeyvInstance(keyv)).toBe(true);
+	});
+
+	test("returns true for object with all Keyv methods", () => {
+		// Arrange
+		const keyvLike = {
+			generateIterator: () => {},
+			get: () => {},
+			getMany: () => {},
+			set: () => {},
+			setMany: () => {},
+			delete: () => {},
+			deleteMany: () => {},
+			has: () => {},
+			hasMany: () => {},
+			clear: () => {},
+			disconnect: () => {},
+			serialize: () => {},
+			deserialize: () => {},
+		};
+
+		// Act & Assert
+		expect(isKeyvInstance(keyvLike)).toBe(true);
+	});
+
+	test("returns false for object missing some Keyv methods", () => {
+		// Arrange
+		const notKeyvLike = {
+			get: () => {},
+			set: () => {},
+			delete: () => {},
+			// Missing other methods
+		};
+
+		// Act & Assert
+		expect(isKeyvInstance(notKeyvLike)).toBe(false);
+	});
+
+	test("returns false for object with non-function Keyv properties", () => {
+		// Arrange
+		const notKeyvLike = {
+			generateIterator: "not a function",
+			get: () => {},
+			getMany: () => {},
+			set: () => {},
+			setMany: () => {},
+			delete: () => {},
+			deleteMany: () => {},
+			has: () => {},
+			hasMany: () => {},
+			clear: () => {},
+			disconnect: () => {},
+			serialize: () => {},
+			deserialize: () => {},
+		};
+
+		// Act & Assert
+		expect(isKeyvInstance(notKeyvLike)).toBe(false);
+	});
+
+	test("returns false for null", () => {
+		// Act & Assert
+		expect(isKeyvInstance(null)).toBe(false);
+	});
+
+	test("returns false for undefined", () => {
+		// Act & Assert
+		expect(isKeyvInstance(undefined)).toBe(false);
+	});
+
+	test("returns false for primitive types", () => {
+		// Act & Assert
+		expect(isKeyvInstance("string")).toBe(false);
+		expect(isKeyvInstance(123)).toBe(false);
+		expect(isKeyvInstance(true)).toBe(false);
+	});
+
+	test("returns false for plain object", () => {
+		// Arrange
+		const plainObject = { foo: "bar" };
+
+		// Act & Assert
+		expect(isKeyvInstance(plainObject)).toBe(false);
+	});
+
+	test("returns false for array", () => {
+		// Act & Assert
+		expect(isKeyvInstance([])).toBe(false);
+		expect(isKeyvInstance([1, 2, 3])).toBe(false);
+	});
+
+	test("returns false for empty object", () => {
+		// Act & Assert
+		expect(isKeyvInstance({})).toBe(false);
+	});
+});