better typing in tests

Author: icebob

template/services/api.service.ts

@@ -1,5 +1,5 @@
 import type { Context, ServiceSchema } from "moleculer";
-
+import type { Server as HttpServer } from 'http';
 import ApiGateway from "moleculer-web";
 import type { ApiSettingsSchema, Route, IncomingRequest, GatewayResponse } from "moleculer-web";
 {{#apiIO}}
@@ -21,7 +21,12 @@ interface Meta {
 	user?: MetaUser | null | undefined;
 }
 
-const ApiService: ServiceSchema<ApiSettingsSchema {{#apiGQL}}& ApolloServiceSettings, ApolloServiceMethods, ApolloServiceLocalVars{{/apiGQL}}> = {
+interface LocalVars {
+	server: HttpServer;
+	io: any;
+}
+
+const ApiService: ServiceSchema<ApiSettingsSchema {{#apiGQL}}& ApolloServiceSettings, ApolloServiceMethods, LocalVars & ApolloServiceLocalVars{{/apiGQL}}> = {
 	name: "api",
 
 	/**

template/test/integration/api.spec.ts

@@ -23,11 +23,11 @@ describe("Test HTTP API gateway", () => {
 	const broker = new ServiceBroker({ logger: false });
 	broker.sendToChannel = vi.fn();
 
-	const greeterService = broker.createService(GreeterSchema) as any;
-	const apiService = broker.createService(APISchema) as any;
+	const greeterService = broker.createService(GreeterSchema);
+	const apiService = broker.createService(APISchema);
 	{{#dbService}}
-	const productsService = broker.createService(ProductsSchema) as any;
-	(productsService as any).seedDB = null; // Disable seeding
+	const productsService = broker.createService(ProductsSchema);
+	productsService.seedDB = undefined; // Disable seeding
 	{{/dbService}}
 
 	beforeAll(async () => {
@@ -217,11 +217,11 @@ describe("Test Socket.IO API gateway", () => {
 	let broker = new ServiceBroker({ logger: false });
 	broker.sendToChannel = vi.fn();
 
-	let greeterService = broker.createService(GreeterSchema) as any;
-	let apiService = broker.createService(APISchema) as any;
+	let greeterService = broker.createService(GreeterSchema);
+	let apiService = broker.createService(APISchema);
 	{{#dbService}}
-	let productsService = broker.createService(ProductsSchema) as any;
-	(productsService as any).seedDB = null; // Disable seeding
+	let productsService = broker.createService(ProductsSchema);
+	productsService.seedDB = undefined; // Disable seeding
 	{{/dbService}}
 
 	beforeAll(() => broker.start());
@@ -412,7 +412,7 @@ describe("Test GraphQL API gateway", () => {
 	let apiService = broker.createService(APISchema);
 	{{#dbService}}
 	let productsService = broker.createService(ProductsSchema);
-	(productsService as any).seedDB = null; // Disable seeding
+	productsService.seedDB = undefined; // Disable seeding
 	{{/dbService}}
 
 	beforeAll(() => broker.start());

template/test/integration/products.service.spec.ts

@@ -7,8 +7,8 @@ import TestService from "../../services/products.service.js";
 describe("Test 'products' service", () => {
 	describe("Test actions", () => {
 		const broker = new ServiceBroker({ logger: false });
-		const service = broker.createService(TestService) as any;
-		service.seedDB = null; // Disable seeding
+		const service = broker.createService(TestService);
+		service.seedDB = undefined; // Disable seeding
 
 		broker.sendToChannel = vi.fn();
 

template/test/unit/services/products.spec.ts

@@ -2,16 +2,17 @@ import { afterAll, beforeAll, describe, it, expect, vi } from "vitest";
 
 import { Context, Errors, ServiceBroker } from "moleculer";
 import type { ServiceSchema } from "moleculer";
+import type { BaseAdapter } from "@moleculer/database";
 import TestService from "../../../services/products.service.js";
 
 describe("Test 'products' service", () => {
 	describe("Test actions", () => {
 		const broker = new ServiceBroker({ logger: false });
-		const service = broker.createService(TestService) as any;
+		const service = broker.createService(TestService);
 
 		service.seedDB = vi.fn();
-		vi.spyOn(service, "updateEntity");
-		vi.spyOn(service, "entityChanged");
+		const mockedUpdateEntity = vi.spyOn(service, "updateEntity");
+		const mockedEntityChanged = vi.spyOn(service, "entityChanged");
 
 		const record = {
 			_id: "123",
@@ -63,8 +64,8 @@ describe("Test 'products' service", () => {
 
 		describe("Test 'products.decreaseQuantity'", () => {
 			it("should call the adapter updateById method & transform result", async () => {
-				service.updateEntity.mockClear();
-				service.entityChanged.mockClear();
+				mockedUpdateEntity.mockClear();
+				mockedEntityChanged.mockClear();
 
 				const res = await broker.call("products.decreaseQuantity", {
 					id: "123",
@@ -94,8 +95,8 @@ describe("Test 'products' service", () => {
 			});
 
 			it("should throw error if params is not valid", async () => {
-				service.updateEntity.mockClear();
-				service.entityChanged.mockClear();
+				mockedUpdateEntity.mockClear();
+				mockedEntityChanged.mockClear();
 
 				expect.assertions(2);
 				try {
@@ -122,7 +123,7 @@ describe("Test 'products' service", () => {
 
 	describe("Test methods", () => {
 		const broker = new ServiceBroker({ logger: false });
-		const service = broker.createService(TestService) as any;
+		const service = broker.createService(TestService);
 
 		vi.spyOn(service, "seedDB");
 
@@ -131,7 +132,7 @@ describe("Test 'products' service", () => {
 			count: vi.fn(async () => 0),
 			insertMany: vi.fn()
 		};
-		service.getAdapter = async () => adapter;
+		service.getAdapter = async () => adapter as any as BaseAdapter;
 
 		beforeAll(() => broker.start());
 		afterAll(() => broker.stop());