fix DBMixin

Author: icebob

template/mixins/db.mixin.ts

@@ -1,14 +1,48 @@
 import type { Context, ServiceSettingSchema, ServiceSchema } from "moleculer";
 import { Service as DbService } from "@moleculer/database";
-import type { DatabaseMethods } from "@moleculer/database";
+import type { DatabaseMethods, DatabaseMixinOptions } from "@moleculer/database";
+import _ from "lodash";
+import process from "node:process";
 
 export type DbServiceMethods = DatabaseMethods & {
 	seedDB?(): Promise<void>;
 };
 
+export interface DbMixinOpts extends DatabaseMixinOptions{
+	collection: string;
+}
+
 type DbServiceSchema = Partial<ServiceSchema<ServiceSettingSchema, DbServiceMethods>>;
 
-export default function (collection: string): DbServiceSchema {
+export default function (opts: DbMixinOpts): DbServiceSchema {
+	const collection = opts?.collection;
+
+	opts = _.defaultsDeep(opts, {
+		adapter:
+			// In production use MongoDB
+			process.env.DB_URI?.startsWith("mongodb://")
+				? {
+						type: "MongoDB",
+						options: {
+							uri: process.env.DB_URI
+						}
+					}
+				: {
+						type: "NeDB",
+						options:
+							// In unit/integration tests use in-memory DB. Jest sets the NODE_ENV automatically
+							// During dev use file storage
+							process.env.NODE_ENV === "test"
+								? {
+										neDB: {
+											inMemoryOnly: true
+										}
+									}
+								: `./data/${collection}.db`
+					},
+		strict: false
+	});
+
 	const cacheCleanEventName = `cache.clean.${collection}`;
 
 	const schema: DbServiceSchema = {
@@ -17,31 +51,7 @@ export default function (collection: string): DbServiceSchema {
 		 */
 		mixins: [
 			// @moleculer/database config: More info: https://github.com/moleculerjs/database
-			DbService({
-				adapter:
-					// In production use MongoDB
-					process.env.DB_URI?.startsWith("mongodb://")
-						? {
-								type: "MongoDB",
-								options: {
-									uri: process.env.DB_URI
-								}
-							}
-						: {
-								type: "NeDB",
-								options:
-									// In unit/integration tests use in-memory DB. Jest sets the NODE_ENV automatically
-									// During dev use file storage
-									process.env.NODE_ENV === "test"
-										? {
-												neDB: {
-													inMemoryOnly: true
-												}
-											}
-										: `./data/${collection}.db`
-							},
-				strict: false
-			})
+			DbService(opts)
 		],
 
 		/**
@@ -53,33 +63,7 @@ export default function (collection: string): DbServiceSchema {
 			 * clean the cache entries for this service.
 			 */
 			async [cacheCleanEventName]() {
-				if (this.broker.cacher) {
-					await this.broker.cacher.clean(`${this.fullName}.*`);
-				}
-			}
-		},
-
-		/**
-		 * Methods. More info: https://moleculer.services/docs/0.15/services.html#Methods
-		 */
-		methods: {
-			/**
-			 * Send a cache clearing event when an entity changed.
-			 *
-			 * @param {String} type
-			 * @param {object} data
-			 * @param {object} oldData
-			 * @param {Context} ctx
-			 * @param {object} opts
-			 */
-			async entityChanged(
-				type: string,
-				data: object,
-				oldData: object,
-				ctx: Context,
-				opts: object
-			) {
-				ctx.broadcast(cacheCleanEventName);
+				await this.broker.cacher?.clean(`${this.fullName}.*`);
 			}
 		},
 

template/services/products.service.ts

@@ -27,7 +27,7 @@ const ProductsService: ServiceSchema<ProductSettings, DbServiceMethods> = {
 	/**
 	 * Mixins. More info: https://moleculer.services/docs/0.15/services.html#Mixins
 	 */
-	mixins: [DbMixin("products") as ServiceSchema],
+	mixins: [DbMixin({ collection: "products" }) as ServiceSchema],
 
 	/**
 	 * Settings. More info: https://moleculer.services/docs/0.15/services.html#Settings

template/test/unit/mixins/db.mixin.spec.ts

@@ -11,7 +11,7 @@ describe("Test DB mixin", () => {
 		afterAll(() => broker.stop());
 
 		it("check schema properties", async () => {
-			const schema = DbMixin("my-collection") as any;
+			const schema = DbMixin({ collection: "my-collection" }) as any;
 
 			expect(schema.started).toBeDefined();
 			expect(schema.events["cache.clean.my-collection"]).toBeInstanceOf(Function);
@@ -21,7 +21,7 @@ describe("Test DB mixin", () => {
 		it("check cache event handler", async () => {
 			vi.spyOn(broker.cacher!, "clean");
 
-			const schema = DbMixin("my-collection") as any;
+			const schema = DbMixin({ collection: "my-collection" }) as any;
 
 			await schema.events["cache.clean.my-collection"].call({
 				broker,
@@ -34,7 +34,7 @@ describe("Test DB mixin", () => {
 
 		describe("Check service started handler", () => {
 			it("should not call seedDB method", async () => {
-				const schema = DbMixin("my-collection") as any;
+				const schema = DbMixin({ collection: "my-collection" }) as any;
 
 				const adapterMock = {
 					count: vi.fn(async () => 10)
@@ -58,7 +58,7 @@ describe("Test DB mixin", () => {
 			});
 
 			it("should call seedDB method", async () => {
-				const schema = DbMixin("my-collection") as any;
+				const schema = DbMixin({ collection: "my-collection" }) as any;
 
 				const adapterMock = {
 					count: vi.fn(async () => 0)
@@ -84,7 +84,7 @@ describe("Test DB mixin", () => {
 		});
 
 		it("should broadcast a cache clear event", async () => {
-			const schema = DbMixin("my-collection");
+			const schema = DbMixin({ collection: "my-collection" });
 
 			const ctx = {
 				broadcast: vi.fn()