✨ defaultTTL

Author: Timeraa

lib/index.d.ts

@@ -3,14 +3,44 @@ import { KeyValueCache } from "apollo-server-caching";
 import { Collection, Document, FindOptions } from "mongodb";
 declare type DataSourceOperation = "findOne" | "find" | "count";
 export default class MongoDataSource<TSchema extends Document = Document> implements DataSource {
-    cache?: KeyValueCache<string> | undefined;
-    context: any;
+    /**
+     * MongoDB collection for the data source.
+     */
     collection: Collection<TSchema>;
+    /**
+     * Cache instance
+     */
+    cache?: KeyValueCache<string> | undefined;
+    /**
+     * The prefix for the cache key
+     * @default "mongodb"
+     */
     cachePrefix: string;
     private pendingResults;
-    constructor(collection: Collection<TSchema>, cache?: KeyValueCache<string> | undefined);
+    private defaultTTL;
+    constructor(
+    /**
+     * MongoDB collection for the data source.
+     */
+    collection: Collection<TSchema>, 
+    /**
+     * Cache instance
+     */
+    cache?: KeyValueCache<string> | undefined, 
+    /**
+     * Options for the DataSource
+     */
+    options?: {
+        /**
+         * The default TTL for the cache
+         */
+        defaultTTL?: number;
+        /**
+         * The prefix for the cache key
+         */
+        cachePrefix?: string;
+    });
     initialize({ cache }: {
-        context: any;
         cache: KeyValueCache;
     }): void;
     count(query?: {}, options?: {
@@ -24,8 +54,8 @@ export default class MongoDataSource<TSchema extends Document = Document> implem
         ttl: number;
         findOptions?: FindOptions;
     }): Promise<TSchema | null>;
-    delete(type: DataSourceOperation, fields: any, options?: {
-        findOptions?: FindOptions<Document>;
+    delete(type: DataSourceOperation, fields?: any, options?: {
+        findOptions?: FindOptions;
     }): Promise<boolean | void | undefined>;
     private getCacheKey;
     private antiSpam;

lib/index.js

@@ -1,6 +1,6 @@
 {
 	"name": "apollo-mongodb-datasource",
-	"version": "1.0.5",
+	"version": "1.1.0",
 	"description": "An Apollo GraphQL Datasource using MongoDB.",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
@@ -12,11 +12,11 @@
 		"dev": "tsc -w"
 	},
 	"dependencies": {
-		"apollo-datasource": "^3.2.0",
-		"apollo-server-caching": "^3.2.0",
-		"mongodb": "^4.1.3"
+		"apollo-datasource": "^3.3.1",
+		"apollo-server-caching": "^3.3.0",
+		"mongodb": "^4.3.1"
 	},
 	"devDependencies": {
-		"typescript": "^4.4.4"
+		"typescript": "^4.5.5"
 	}
 }

lib/index.js.map

@@ -7,24 +7,50 @@ type DataSourceOperation = "findOne" | "find" | "count";
 export default class MongoDataSource<TSchema extends Document = Document>
 	implements DataSource
 {
-	context: any;
-	collection: Collection<TSchema>;
-
-	cachePrefix: string;
+	/**
+	 * The prefix for the cache key
+	 * @default "mongodb"
+	 */
+	cachePrefix = "mongodb";
 
 	private pendingResults: { key: string; promise: Promise<any> }[] = [];
 
-	constructor(collection: Collection<TSchema>, public cache?: KeyValueCache) {
-		this.collection = collection;
+	private defaultTTL = 60;
+
+	constructor(
+		/**
+		 * MongoDB collection for the data source.
+		 */
+		public collection: Collection<TSchema>,
+		/**
+		 * Cache instance
+		 */
+		public cache?: KeyValueCache,
+		/**
+		 * Options for the DataSource
+		 */
+		options?: {
+			/**
+			 * The default TTL for the cache
+			 */
+			defaultTTL?: number;
+			/**
+			 * The prefix for the cache key
+			 */
+			cachePrefix?: string;
+		}
+	) {
+		this.cachePrefix = `${this.cachePrefix}-${this.collection.dbName}-${this.collection.collectionName}-`;
 
-		this.cachePrefix = `mongo-${this.collection.dbName}-${this.collection.collectionName}-`;
+		if (options?.defaultTTL) this.defaultTTL = options.defaultTTL;
+		if (options?.cachePrefix) this.cachePrefix = options.cachePrefix;
 	}
 
-	initialize({ cache }: { context: any; cache: KeyValueCache }) {
+	initialize({ cache }: { cache: KeyValueCache }) {
 		this.cache = cache;
 	}
 
-	async count(query: {} = {}, options = { ttl: 60 }) {
+	async count(query: {} = {}, options = { ttl: this.defaultTTL }) {
 		const cacheKey = this.getCacheKey("count", query),
 			cacheDoc = await this.cache?.get(cacheKey);
 		if (cacheDoc) return JSON.parse(cacheDoc);
@@ -42,7 +68,7 @@ export default class MongoDataSource<TSchema extends Document = Document>
 	async find(
 		fields: any = {},
 		options: { ttl: number; findOptions?: FindOptions<Document> } = {
-			ttl: 60
+			ttl: this.defaultTTL
 		}
 	): Promise<TSchema[]> {
 		const cacheKey = this.getCacheKey("find", fields, options),
@@ -54,7 +80,7 @@ export default class MongoDataSource<TSchema extends Document = Document>
 			const r = await this.collection
 				.find(fields, options.findOptions)
 				.toArray();
-			this.cache?.set(cacheKey, JSON.stringify(r), options);
+			await this.cache?.set(cacheKey, JSON.stringify(r), options);
 
 			return r;
 		});
@@ -65,7 +91,7 @@ export default class MongoDataSource<TSchema extends Document = Document>
 	async findOne(
 		fields: any = {},
 		options: { ttl: number; findOptions?: FindOptions } = {
-			ttl: 60
+			ttl: this.defaultTTL
 		}
 	): Promise<TSchema | null> {
 		const cacheKey = this.getCacheKey("findOne", fields, options),
@@ -75,7 +101,7 @@ export default class MongoDataSource<TSchema extends Document = Document>
 
 		const docs = await this.antiSpam(cacheKey, async () => {
 			const r = await this.collection.findOne(fields, options.findOptions);
-			this.cache?.set(cacheKey, JSON.stringify(r), options);
+			await this.cache?.set(cacheKey, JSON.stringify(r), options);
 
 			return r;
 		});
@@ -85,7 +111,7 @@ export default class MongoDataSource<TSchema extends Document = Document>
 
 	async delete(
 		type: DataSourceOperation,
-		fields: any,
+		fields: any = {},
 		options: { findOptions?: FindOptions } = {}
 	) {
 		return await this.cache?.delete(this.getCacheKey(type, fields, options));