Merge pull request #10 from Timeraa/RCD-98

feat(RCD-98): add support for distinct

Author: Timeraa

README.md

@@ -22,6 +22,7 @@ _These functions automatically handle caching_
 - find
 - findOne
 - countDocuments
+- distinct
 
 **NOTE: When you update/insert/delete a document, the cache is not updated, you'll need to manually clear the cache using `customClass.clear()` or `customClass.keyv.clear()`**
 

__tests__/index.test.ts

@@ -12,10 +12,14 @@ afterAll(async () => {
 	await connection.close();
 });
 
-class TestClass extends MongoDBCaching {}
+class TestClass extends MongoDBCaching<{
+	test: boolean;
+	title: string;
+}> {}
 
-const doc = { test: true },
-	doc1 = { test: false };
+const doc = { test: true, title: "test" },
+	doc1 = { test: false, title: "test" },
+	doc2 = { test: true, title: "test2" };
 
 describe("MongoDB-Caching", () => {
 	let cacheClass: TestClass;
@@ -25,7 +29,7 @@ describe("MongoDB-Caching", () => {
 	beforeAll(async () => {
 		cacheClass = new TestClass(connection.db("test").collection("test"));
 
-		await cacheClass.collection.insertMany([doc, doc1]);
+		await cacheClass.collection.insertMany([doc, doc1, doc2]);
 	});
 
 	it("should have no context", () => {
@@ -77,7 +81,7 @@ describe("MongoDB-Caching", () => {
 
 		expect(dbCountDocumentsSpy).toHaveBeenCalledTimes(1);
 
-		expect(res).toBe(2);
+		expect(res).toBe(3);
 
 		dbCountDocumentsSpy.mockRestore();
 	});
@@ -93,7 +97,7 @@ describe("MongoDB-Caching", () => {
 
 		expect(dbCountDocumentsSpy).toHaveBeenCalledTimes(1);
 
-		expect(res).toBe(2);
+		expect(res).toBe(3);
 
 		dbCountDocumentsSpy.mockRestore();
 	});
@@ -111,7 +115,7 @@ describe("MongoDB-Caching", () => {
 		const res = await cacheClass.find();
 
 		expect(dbFindSpy).toHaveBeenCalledTimes(1);
-		expect(res).toMatchObject([doc, doc1]);
+		expect(res).toMatchObject([doc, doc1, doc2]);
 
 		dbFindSpy.mockRestore();
 	});
@@ -133,8 +137,8 @@ describe("MongoDB-Caching", () => {
 			{ cursor: c => c.skip(1).toArray() }
 		);
 
-		expect(res1).toHaveLength(1);
-		expect(res1).toMatchObject([doc1]);
+		expect(res1).toHaveLength(2);
+		expect(res1).toMatchObject([doc1, doc2]);
 		expect(dbFindSpy).toHaveBeenCalledTimes(2);
 
 		dbFindSpy.mockRestore();
@@ -148,7 +152,7 @@ describe("MongoDB-Caching", () => {
 
 		expect(dbFindSpy).toHaveBeenCalledTimes(1);
 
-		expect(res).toMatchObject([doc, doc1]);
+		expect(res).toMatchObject([doc, doc1, doc2]);
 
 		dbFindSpy.mockRestore();
 	});
@@ -197,4 +201,29 @@ describe("MongoDB-Caching", () => {
 
 		activeThrottlesSpy.mockClear();
 	});
+
+	it("should return the distinct documents", async () => {
+		const dbDistinctSpy = jest.spyOn(cacheClass.collection, "distinct");
+
+		const res = await cacheClass.distinct("title", {});
+
+		expect(dbDistinctSpy).toHaveBeenCalledTimes(1);
+
+		expect(res).toStrictEqual(["test", "test2"]);
+
+		dbDistinctSpy.mockRestore();
+	});
+
+	it("should return the cached distinct documents", async () => {
+		const dbDistinctSpy = jest.spyOn(cacheClass.collection, "distinct");
+
+		await cacheClass.distinct("title", {});
+		const res = await cacheClass.distinct("title", {});
+
+		expect(dbDistinctSpy).toHaveBeenCalledTimes(1);
+
+		expect(res).toStrictEqual(["test", "test2"]);
+
+		dbDistinctSpy.mockRestore();
+	});
 });

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "mongodb-caching",
-	"version": "1.0.1",
+	"version": "1.1.0",
 	"description": "MongoDB with automatic Caching functionality using Keyv.",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",

src/index.ts

@@ -8,10 +8,15 @@ import type {
 	Filter,
 	FindCursor,
 	FindOptions,
-	WithId
+	WithId,
+	Document,
+	DistinctOptions
 } from "mongodb";
 
-export default class MongoDBCaching<TSchema = any, TContext = any> {
+export default class MongoDBCaching<
+	TSchema extends Document = Document,
+	TContext = any
+> {
 	keyv: Keyv;
 	context?: TContext;
 
@@ -69,12 +74,12 @@ export default class MongoDBCaching<TSchema = any, TContext = any> {
 		filter: Filter<TSchema> = {},
 		options?: {
 			findOptions?: FindOptions<Document>;
-			cursor: (c: FindCursor<WithId<TSchema>>) => Promise<WithId<TSchema>[]>;
+			cursor?: (c: FindCursor<WithId<TSchema>>) => Promise<WithId<TSchema>[]>;
 			ttl?: number;
 		}
 	): Promise<WithId<TSchema>[]> {
 		const cacheKeyOptions = options
-			? { ...options, cursor: options.cursor.toString() }
+			? { ...options, cursor: options.cursor?.toString() }
 			: undefined;
 
 		const cacheKey = "find-" + this.getCacheKey(filter, cacheKeyOptions);
@@ -85,7 +90,7 @@ export default class MongoDBCaching<TSchema = any, TContext = any> {
 			if (cacheDoc) return cacheDoc;
 
 			const res =
-				(await options?.cursor(
+				(await options?.cursor?.(
 					this.collection.find(filter, options.findOptions)
 				)) ||
 				(await this.collection.find(filter, options?.findOptions).toArray());
@@ -118,6 +123,33 @@ export default class MongoDBCaching<TSchema = any, TContext = any> {
 		});
 	}
 
+	async distinct<Key extends keyof WithId<TSchema>>(
+		key: Key,
+		filter: Filter<TSchema>,
+		options?: {
+			distinctOptions?: DistinctOptions;
+			ttl?: number;
+		}
+	) {
+		const cacheKey = `distinct-${key.toString()}-` + this.getCacheKey(filter);
+
+		return this.throttleFunction(cacheKey, async () => {
+			const cacheDoc = await this.keyv.get(cacheKey);
+
+			if (cacheDoc) return cacheDoc;
+
+			const res = await this.collection.distinct(
+				key,
+				filter,
+				options?.distinctOptions as DistinctOptions
+			);
+
+			await this.keyv.set(cacheKey, res, options?.ttl);
+
+			return res;
+		});
+	}
+
 	async clear() {
 		return this.keyv.clear();
 	}