chore(data-service): typecheck tests (#7549)

Author: Anemy

packages/data-service/package.json

@@ -49,7 +49,7 @@
     "test-watch": "npm run test -- --watch",
     "test-ci": "npm run test-cov -- -- --include \"./**/*.{spec,test}.*\"  --exclude \"./src/connect.spec.ts\" --exclude \"./src/csfle-collection-tracker.spec.ts\"",
     "reformat": "npm run eslint . -- --fix && npm run prettier -- --write .",
-    "typecheck": "echo \"TODO(COMPASS-9897): typecheck is failing in test files\" && tsc -p tsconfig-build.json --noEmit"
+    "typecheck": "tsc -p tsconfig.json --noEmit"
   },
   "dependencies": {
     "@mongodb-js/compass-logging": "^1.7.23",

packages/data-service/src/connect.spec.ts

@@ -11,7 +11,7 @@ import { UUID } from 'mongodb';
 
 import connect from './connect';
 import type { ConnectionOptions } from './connection-options';
-import type DataService from './data-service';
+import type { DataServiceImpl, default as DataService } from './data-service';
 import { redactConnectionOptions } from './redact';
 import { runCommand } from './run-command';
 import { MongoLogWriter } from 'mongodb-log-writer';
@@ -37,7 +37,7 @@ const buildConnectionString = (
   username: string | undefined,
   password: string | undefined,
   host: string | undefined,
-  params?: MongoClientOptions
+  params?: Partial<Record<keyof MongoClientOptions, string>>
 ): string => {
   if (!username || !password || !host) {
     return '';
@@ -135,7 +135,7 @@ describe('connect', function () {
         return this.skip();
       }
 
-      let dataService: DataService;
+      let dataService: DataService | undefined;
 
       try {
         dataService = await connect({
@@ -147,11 +147,14 @@ describe('connect', function () {
         const explainPlan = await dataService.explainFind('test.test', {}, {});
 
         const targetHost = explainPlan?.serverInfo?.host;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const replSetStatus: any = await runCommand(
-          dataService['_database']('admin', 'META'),
+          (dataService as DataServiceImpl)['_database']('admin', 'META'),
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
           { replSetGetStatus: 1 } as any
         );
-        const targetHostStatus = replSetStatus?.members.find((member) =>
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const targetHostStatus = replSetStatus?.members.find((member: any) =>
           member.name.startsWith(targetHost)
         );
 
@@ -166,7 +169,7 @@ describe('connect', function () {
         return this.skip();
       }
 
-      let dataService: DataService;
+      let dataService: DataService | undefined;
 
       try {
         dataService = await connect({
@@ -177,18 +180,23 @@ describe('connect', function () {
 
         const explainPlan = await dataService.explainFind('test.test', {}, {});
 
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const replSetGetConfig: any = await runCommand(
-          dataService['_database']('admin', 'META'),
+          (dataService as DataServiceImpl)['_database']('admin', 'META'),
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
           { replSetGetConfig: 1 } as any
         );
 
-        const analtyticsNode = replSetGetConfig?.config?.members.find(
-          (member) => member?.tags.nodeType === 'ANALYTICS'
+        const analyticsNode = replSetGetConfig?.config?.members.find(
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          (member: any) => member?.tags.nodeType === 'ANALYTICS'
         );
 
+        expect(explainPlan?.serverInfo?.host).to.exist;
+
         // test that queries are routed to the analytics node
         expect(explainPlan?.serverInfo?.host).to.be.equal(
-          analtyticsNode?.host.split(':')[0]
+          analyticsNode?.host.split(':')[0]
         );
       } finally {
         await dataService?.disconnect();
@@ -694,7 +702,7 @@ async function connectAndGetAuthInfo(connectionOptions: ConnectionOptions) {
         : undefined,
     });
     const connectionStatus = await runCommand(
-      dataService['_database']('admin', 'META'),
+      (dataService as DataServiceImpl)['_database']('admin', 'META'),
       { connectionStatus: 1 }
     );
 

packages/data-service/src/connection-attempt.spec.ts

@@ -9,6 +9,7 @@ const { mongoLogId } = createLogger('CONNECTION-ATTEMPT-TEST');
 
 describe('ConnectionAttempt Module', function () {
   let logger: UnboundDataServiceImplLogger;
+  const proxyOptions = {};
 
   beforeEach(function () {
     logger = {
@@ -30,6 +31,7 @@ describe('ConnectionAttempt Module', function () {
           return dataService;
         },
         logger,
+        proxyOptions,
       });
       const connectionAttemptResult = await connectionAttempt.connect({
         connectionString: 'mongodb://localhost:27017',
@@ -45,6 +47,7 @@ describe('ConnectionAttempt Module', function () {
           return dataService;
         },
         logger,
+        proxyOptions,
       });
 
       const connectPromise = connectionAttempt.connect({
@@ -65,6 +68,7 @@ describe('ConnectionAttempt Module', function () {
             throw new Error('should have been thrown');
           },
           logger,
+          proxyOptions,
         });
 
         await connectionAttempt.connect({
@@ -93,6 +97,7 @@ describe('ConnectionAttempt Module', function () {
           return dataService;
         },
         logger,
+        proxyOptions,
       });
       await connectionAttempt.connect({
         connectionString: 'mongodb://localhost:27017',

packages/data-service/src/csfle-collection-tracker.spec.ts

@@ -371,7 +371,7 @@ describe('CSFLECollectionTracker', function () {
   });
 
   context('with server-side FLE2 schema info', function () {
-    let SOME_UUID1, SOME_UUID2;
+    let SOME_UUID1: Binary, SOME_UUID2: Binary;
     beforeEach(async function () {
       [tracker, dataService, SOME_UUID1, SOME_UUID2] = await createTracker();
       // Creating the collections needs to be done through the non-FLE-aware
@@ -468,7 +468,7 @@ describe('CSFLECollectionTracker', function () {
           err = error;
         }
         expect(err).to.be.instanceOf(Error);
-        expect(err.message).to.match(
+        expect((err as Error).message).to.match(
           /\[Compass\] Missing encrypted field information for collection/
         );
       });
@@ -493,7 +493,7 @@ describe('CSFLECollectionTracker', function () {
           err = error;
         }
         expect(err).to.be.instanceOf(Error);
-        expect(err.message).to.match(
+        expect((err as Error).message).to.match(
           /\[Compass\] Missing encrypted field 'a' of collection/
         );
       });

packages/data-service/src/data-service.spec.ts

@@ -16,7 +16,6 @@ import type {
 import EventEmitter from 'events';
 import type { ClientMockOptions } from '../test/helpers';
 import { createMongoClientMock } from '../test/helpers';
-import { AbortController } from '../test/mocks';
 import { createClonedClient } from './connect-mongo-client';
 import { runCommand } from './run-command';
 import { mochaTestServer } from '@mongodb-js/compass-test-server';
@@ -153,12 +152,14 @@ describe('DataService', function () {
         const { info: [, , , , startedAttr] = [] } = startedLog ?? {};
         expect(startedAttr).to.have.property(
           'connectionId',
-          dataServiceLogTest._id
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          (dataServiceLogTest as any)._id
         );
         const { info: [, , , , succeededAttr] = [] } = succeededLog ?? {};
         expect(succeededAttr).to.have.property(
           'connectionId',
-          dataServiceLogTest._id
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          (dataServiceLogTest as any)._id
         );
       });
 
@@ -197,12 +198,14 @@ describe('DataService', function () {
         const { info: [, , , , startedAttr] = [] } = startedLog ?? {};
         expect(startedAttr).to.have.property(
           'connectionId',
-          dataServiceLogTest._id
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          (dataServiceLogTest as any)._id
         );
         const { info: [, , , , succeededAttr] = [] } = failedLog ?? {};
         expect(succeededAttr).to.have.property(
           'connectionId',
-          dataServiceLogTest._id
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          (dataServiceLogTest as any)._id
         );
       });
     });
@@ -269,17 +272,17 @@ describe('DataService', function () {
           connectionId,
           duration: 400,
           failure: new Error('fail'),
-        });
+        } as any);
         client.emit('serverHeartbeatFailed', {
           connectionId,
           duration: 600,
           failure: new Error('fail'),
-        });
+        } as any);
         client.emit('serverHeartbeatFailed', {
           connectionId,
           duration: 800,
           failure: new Error('fail'),
-        });
+        } as any);
         const logEntries = [
           // Picking the attrs part of the log
           ...logger.debug.args.map((args) => args[4]),
@@ -1431,7 +1434,7 @@ describe('DataService', function () {
         const topology = dataService.getLastSeenTopology();
 
         expect(topology).to.not.be.null;
-        expect(topology!.servers.values().next().value.address).to.be.a(
+        expect(topology!.servers.values().next().value!.address).to.be.a(
           'string'
         );
 

packages/data-service/src/data-service.ts

@@ -1741,7 +1741,7 @@ class DataServiceImpl extends WithLogContext implements DataService {
     filter: Filter<Document>,
     options: CountDocumentsOptions = {},
     executionOptions?: ExecutionOptions & {
-      fallbackReadPreference: ReadPreferenceMode;
+      fallbackReadPreference?: ReadPreferenceMode;
     }
   ): Promise<number> {
     return this._cancellableOperation(

packages/data-service/test/helpers.ts

@@ -40,8 +40,9 @@ export function createMongoClientMock({
 } {
   const db = {
     command(spec: Document) {
-      const cmd = Object.keys(spec).find((key) =>
-        ALLOWED_COMMANDS.includes(key as (typeof ALLOWED_COMMANDS)[number])
+      const cmd = Object.keys(spec).find(
+        (key): key is (typeof ALLOWED_COMMANDS)[number] =>
+          ALLOWED_COMMANDS.includes(key as (typeof ALLOWED_COMMANDS)[number])
       );
       if (cmd && commands[cmd]) {
         const command = commands[cmd];
@@ -55,7 +56,7 @@ export function createMongoClientMock({
       return Promise.reject(
         new Error(
           `not authorized on ${String(
-            this.databaseName
+            (this as unknown as ReturnType<MongoClient['db']>).databaseName
           )} to execute command ${JSON.stringify(spec)}`
         )
       );