chore: add tests for warnIfVectorSearchNotEnabledCorrectly

Author: himanshusinghs

src/common/config.ts

@@ -372,18 +372,18 @@ export function registerKnownSecretsInRootKeychain(userConfig: Partial<UserConfi
     maybeRegister(userConfig.username, "user");
 }
 
-function warnIfVectorSearchNotEnabledCorrectly(config: UserConfig): void {
+export function warnIfVectorSearchNotEnabledCorrectly(config: UserConfig, warn: (message: string) => void): void {
     const vectorSearchEnabled = config.previewFeatures.includes("vectorSearch");
     const embeddingsProviderConfigured = !!config.voyageApiKey;
     if (vectorSearchEnabled && !embeddingsProviderConfigured) {
-        console.warn(`\
+        warn(`\
 Warning: Vector search is enabled but no embeddings provider is configured.
 - Set an embeddings provider configuration option to enable auto-embeddings during document insertion and text-based queries with $vectorSearch.\
 `);
     }
 
     if (!vectorSearchEnabled && embeddingsProviderConfigured) {
-        console.warn(`\
+        warn(`\
 Warning: An embeddings provider is configured but the 'vectorSearch' preview feature is not enabled.
 - Enable vector search by adding 'vectorSearch' to the 'previewFeatures' configuration option, or remove the embeddings provider configuration if not needed.\
 `);
@@ -410,7 +410,7 @@ export function setupUserConfig({ cli, env }: { cli: string[]; env: Record<strin
     // We don't have as schema defined for all args-parser arguments so we need to merge the raw config with the parsed config.
     const userConfig = { ...rawConfig, ...parseResult.data } as UserConfig;
 
-    warnIfVectorSearchNotEnabledCorrectly(userConfig);
+    warnIfVectorSearchNotEnabledCorrectly(userConfig, (message) => console.warn(message));
     registerKnownSecretsInRootKeychain(userConfig);
     return userConfig;
 }

tests/unit/common/config.test.ts

@@ -5,11 +5,13 @@ import {
     registerKnownSecretsInRootKeychain,
     warnAboutDeprecatedOrUnknownCliArgs,
     UserConfigSchema,
+    warnIfVectorSearchNotEnabledCorrectly,
 } from "../../../src/common/config.js";
 import { getLogPath, getExportsPath } from "../../../src/common/configUtils.js";
 import type { CliOptions } from "@mongosh/arg-parser";
 import { Keychain } from "../../../src/common/keychain.js";
 import type { Secret } from "../../../src/common/keychain.js";
+import { defaultTestConfig } from "../../integration/helpers.js";
 
 describe("config", () => {
     it("should generate defaults from UserConfigSchema that match expected values", () => {
@@ -792,6 +794,51 @@ describe("CLI arguments", () => {
         });
     });
 
+    describe("warnIfVectorSearchNotEnabledCorrectly", () => {
+        it("should warn if vectorSearch is enabled but embeddings provider is not configured", () => {
+            const warnStub = vi.fn();
+            warnIfVectorSearchNotEnabledCorrectly(
+                {
+                    ...defaultTestConfig,
+                    previewFeatures: ["vectorSearch"],
+                },
+                warnStub
+            );
+            expect(warnStub).toBeCalledWith(`\
+Warning: Vector search is enabled but no embeddings provider is configured.
+- Set an embeddings provider configuration option to enable auto-embeddings during document insertion and text-based queries with $vectorSearch.\
+`);
+        });
+
+        it("should warn if vectorSearch is not enabled but embeddings provider is configured", () => {
+            const warnStub = vi.fn();
+            warnIfVectorSearchNotEnabledCorrectly(
+                {
+                    ...defaultTestConfig,
+                    voyageApiKey: "random-key",
+                },
+                warnStub
+            );
+            expect(warnStub).toBeCalledWith(`\
+Warning: An embeddings provider is configured but the 'vectorSearch' preview feature is not enabled.
+- Enable vector search by adding 'vectorSearch' to the 'previewFeatures' configuration option, or remove the embeddings provider configuration if not needed.\
+`);
+        });
+
+        it("should not warn if vectorSearch is enabled correctly", () => {
+            const warnStub = vi.fn();
+            warnIfVectorSearchNotEnabledCorrectly(
+                {
+                    ...defaultTestConfig,
+                    voyageApiKey: "random-key",
+                    previewFeatures: ["vectorSearch"],
+                },
+                warnStub
+            );
+            expect(warnStub).not.toBeCalled();
+        });
+    });
+
     describe("keychain management", () => {
         type TestCase = { readonly cliArg: keyof UserConfig; secretKind: Secret["kind"] };
         const testCases = [