Typing

Author: kylelai1

src/common/atlas/performanceAdvisorUtils.ts

@@ -4,97 +4,20 @@ import { getProcessIdFromCluster } from "./cluster.js";
 import type { components } from "./openapi.js";
 
 export type SuggestedIndex = components["schemas"]["PerformanceAdvisorIndex"];
-
 export type DropIndexSuggestion = components["schemas"]["DropIndexSuggestionsIndex"];
-
 export type SlowQueryLogMetrics = components["schemas"]["PerformanceAdvisorSlowQueryMetrics"];
-
 export type SlowQueryLog = components["schemas"]["PerformanceAdvisorSlowQuery"];
 
 interface SuggestedIndexesResponse {
-    content: {
-        suggestedIndexes?: Array<SuggestedIndex>;
-    };
+    content: components["schemas"]["PerformanceAdvisorResponse"];
 }
-
 interface DropIndexesResponse {
-    content: {
-        hiddenIndexes?: Array<DropIndexSuggestion>;
-        redundantIndexes?: Array<DropIndexSuggestion>;
-        unusedIndexes?: Array<DropIndexSuggestion>;
-    };
+    content: components["schemas"]["DropIndexSuggestionsResponse"];
 }
-
 interface SchemaAdviceResponse {
-    content: {
-        recommendations?: Array<SchemaRecommendation>;
-    };
-}
-
-interface SlowQueriesResponse {
-    slowQueries?: Array<SlowQueryLog>;
-}
-
-export type SchemaTriggerType =
-    | "PERCENT_QUERIES_USE_LOOKUP"
-    | "NUMBER_OF_QUERIES_USE_LOOKUP"
-    | "DOCS_CONTAIN_UNBOUNDED_ARRAY"
-    | "NUMBER_OF_NAMESPACES"
-    | "DOC_SIZE_TOO_LARGE"
-    | "NUM_INDEXES"
-    | "QUERIES_CONTAIN_CASE_INSENSITIVE_REGEX";
-
-export const SCHEMA_TRIGGER_DESCRIPTIONS: Record<SchemaTriggerType, string> = {
-    PERCENT_QUERIES_USE_LOOKUP: "High percentage of queries (>50%) use $lookup operations",
-    NUMBER_OF_QUERIES_USE_LOOKUP: "High number of queries (>100) use $lookup operations",
-    DOCS_CONTAIN_UNBOUNDED_ARRAY: "Arrays with over 10000 entries detected in the collection(s)",
-    NUMBER_OF_NAMESPACES: "Too many namespaces (collections) in the database (>100)",
-    DOC_SIZE_TOO_LARGE: "Documents larger than 2 MB found in the collection(s)",
-    NUM_INDEXES: "More than 30 indexes detected in the collection(s) scanned",
-    QUERIES_CONTAIN_CASE_INSENSITIVE_REGEX: "Queries use case-insensitive regular expressions",
-};
-
-type SchemaRecommedationType =
-    | "REDUCE_LOOKUP_OPS"
-    | "AVOID_UNBOUNDED_ARRAY"
-    | "REDUCE_DOCUMENT_SIZE"
-    | "REMOVE_UNNECESSARY_INDEXES"
-    | "REDUCE_NUMBER_OF_NAMESPACES"
-    | "OPTIMIZE_CASE_INSENSITIVE_REGEX_QUERIES"
-    | "OPTIMIZE_TEXT_QUERIES";
-
-export const SCHEMA_RECOMMENDATION_DESCRIPTIONS: Record<SchemaRecommedationType, string> = {
-    REDUCE_LOOKUP_OPS: "Reduce the use of $lookup operations",
-    AVOID_UNBOUNDED_ARRAY: "Avoid using unbounded arrays in documents",
-    REDUCE_DOCUMENT_SIZE: "Reduce the size of documents",
-    REMOVE_UNNECESSARY_INDEXES: "Remove unnecessary indexes",
-    REDUCE_NUMBER_OF_NAMESPACES: "Reduce the number of collections in the database",
-    OPTIMIZE_CASE_INSENSITIVE_REGEX_QUERIES: "Optimize case-insensitive regex queries",
-    OPTIMIZE_TEXT_QUERIES: "Optimize text search queries",
-};
-
-export interface SchemaRecommendation {
-    affectedNamespaces?: Array<{
-        namespace?: string | null;
-        triggers?: Array<{
-            description?: string;
-            triggerType?: SchemaTriggerType;
-        }>;
-    }>;
-    description?: string;
-    recommendation?: SchemaRecommedationType;
-}
-
-export interface PerformanceAdvisorData {
-    suggestedIndexes: Array<SuggestedIndex>;
-    dropIndexSuggestions: {
-        hiddenIndexes: Array<DropIndexSuggestion>;
-        redundantIndexes: Array<DropIndexSuggestion>;
-        unusedIndexes: Array<DropIndexSuggestion>;
-    };
-    slowQueryLogs: Array<SlowQueryLog>;
-    schemaSuggestions: Array<SchemaRecommendation>;
+    content: components["schemas"]["SchemaAdvisorResponse"];
 }
+export type SchemaRecommendation = components["schemas"]["SchemaAdvisorItemRecommendation"];
 
 export async function getSuggestedIndexes(
     apiClient: ApiClient,
@@ -204,7 +127,7 @@ export async function getSlowQueries(
             },
         });
 
-        return { slowQueryLogs: (response as SlowQueriesResponse).slowQueries ?? [] };
+        return { slowQueryLogs: response.slowQueries ?? [] };
     } catch (err) {
         apiClient.logger.debug({
             id: LogId.atlasPaSlowQueryLogsFailure,

src/tools/atlas/read/listPerformanceAdvisor.ts

@@ -8,7 +8,10 @@ import {
     getDropIndexSuggestions,
     getSchemaAdvice,
     getSlowQueries,
-    type PerformanceAdvisorData,
+    type SuggestedIndex,
+    type DropIndexSuggestion,
+    type SlowQueryLog,
+    type SchemaRecommendation,
 } from "../../../common/atlas/performanceAdvisorUtils.js";
 
 const PerformanceAdvisorOperationType = z.enum([
@@ -17,9 +20,21 @@ const PerformanceAdvisorOperationType = z.enum([
     "slowQueryLogs",
     "schemaSuggestions",
 ]);
+
+interface PerformanceAdvisorData {
+    suggestedIndexes?: Array<SuggestedIndex>;
+    dropIndexSuggestions?: {
+        hiddenIndexes?: Array<DropIndexSuggestion>;
+        redundantIndexes?: Array<DropIndexSuggestion>;
+        unusedIndexes?: Array<DropIndexSuggestion>;
+    };
+    slowQueryLogs?: Array<SlowQueryLog>;
+    schemaSuggestions?: Array<SchemaRecommendation>;
+}
 export class ListPerformanceAdvisorTool extends AtlasToolBase {
     public name = "atlas-list-performance-advisor";
-    protected description = "List MongoDB Atlas performance advisor recommendations";
+    protected description =
+        "List MongoDB Atlas performance advisor recommendations, which includes the operations: suggested indexes, drop index suggestions, slow query logs, and schema suggestions";
     public operationType: OperationType = "read";
     protected argsShape = {
         projectId: z.string().describe("Atlas project ID to list performance advisor recommendations"),
@@ -29,7 +44,10 @@ export class ListPerformanceAdvisorTool extends AtlasToolBase {
             .default(PerformanceAdvisorOperationType.options)
             .describe("Operations to list performance advisor recommendations"),
         since: z.date().describe("Date to list slow query logs since").optional(),
-        namespaces: z.array(z.string()).describe("Namespaces to list slow query logs").optional(),
+        namespaces: z
+            .array(z.string())
+            .describe("Namespaces to list slow query logs. Only relevant for the slowQueryLogs operation.")
+            .optional(),
     };
 
     protected async execute({
@@ -60,8 +78,8 @@ export class ListPerformanceAdvisorTool extends AtlasToolBase {
             if (operations.includes("dropIndexSuggestions")) {
                 performanceAdvisorPromises.push(
                     getDropIndexSuggestions(this.session.apiClient, projectId, clusterName).then(
-                        ({ hiddenIndexes, redundantIndexes, unusedIndexes }) => {
-                            data.dropIndexSuggestions = { hiddenIndexes, redundantIndexes, unusedIndexes };
+                        (dropIndexSuggestions) => {
+                            data.dropIndexSuggestions = dropIndexSuggestions;
                         }
                     )
                 );
@@ -99,23 +117,19 @@ export class ListPerformanceAdvisorTool extends AtlasToolBase {
 
         let formattedOutput = "";
 
-        if (data.suggestedIndexes.length > 0) {
+        if (data.suggestedIndexes && data.suggestedIndexes.length > 0) {
             formattedOutput += `\n## Suggested Indexes\n${JSON.stringify(data.suggestedIndexes)}\n`;
         }
 
-        if (
-            data.dropIndexSuggestions.hiddenIndexes.length > 0 ||
-            data.dropIndexSuggestions.redundantIndexes.length > 0 ||
-            data.dropIndexSuggestions.unusedIndexes.length > 0
-        ) {
+        if (data.dropIndexSuggestions) {
             formattedOutput += `\n## Drop Index Suggestions\n${JSON.stringify(data.dropIndexSuggestions)}\n`;
         }
 
-        if (data.slowQueryLogs.length > 0) {
+        if (data.slowQueryLogs && data.slowQueryLogs.length > 0) {
             formattedOutput += `\n## Slow Query Logs\n${JSON.stringify(data.slowQueryLogs)}\n`;
         }
 
-        if (data.schemaSuggestions.length > 0) {
+        if (data.schemaSuggestions && data.schemaSuggestions.length > 0) {
             formattedOutput += `\n## Schema Suggestions\n${JSON.stringify(data.schemaSuggestions)}\n`;
         }