|
| 1 | +import { |
| 2 | + databaseCollectionParameters, |
| 3 | + setupIntegrationTest, |
| 4 | + validateToolMetadata, |
| 5 | + validateThrowsForInvalidArguments, |
| 6 | + getResponseElements, |
| 7 | +} from "../../../helpers.js"; |
| 8 | +import { describeWithMongoDB, validateAutoConnectBehavior } from "../mongodbHelpers.js"; |
| 9 | + |
| 10 | +describeWithMongoDB("explain tool", (integration) => { |
| 11 | + validateToolMetadata( |
| 12 | + integration, |
| 13 | + "explain", |
| 14 | + "Returns statistics describing the execution of the winning plan chosen by the query optimizer for the evaluated method", |
| 15 | + [ |
| 16 | + ...databaseCollectionParameters, |
| 17 | + |
| 18 | + { |
| 19 | + name: "method", |
| 20 | + description: "The method and its arguments to run", |
| 21 | + type: "array", |
| 22 | + required: true, |
| 23 | + }, |
| 24 | + ] |
| 25 | + ); |
| 26 | + |
| 27 | + validateThrowsForInvalidArguments(integration, "explain", [ |
| 28 | + {}, |
| 29 | + { database: 123, collection: "bar", method: [{ name: "find", arguments: {} }] }, |
| 30 | + { database: "test", collection: true, method: [{ name: "find", arguments: {} }] }, |
| 31 | + { database: "test", collection: "bar", method: [{ name: "dnif", arguments: {} }] }, |
| 32 | + { database: "test", collection: "bar", method: "find" }, |
| 33 | + { database: "test", collection: "bar", method: { name: "find", arguments: {} } }, |
| 34 | + ]); |
| 35 | + |
| 36 | + const testCases = [ |
| 37 | + { |
| 38 | + method: "aggregate", |
| 39 | + arguments: { pipeline: [{ $match: { name: "Peter" } }] }, |
| 40 | + }, |
| 41 | + { |
| 42 | + method: "find", |
| 43 | + arguments: { filter: { name: "Peter" } }, |
| 44 | + }, |
| 45 | + { |
| 46 | + method: "count", |
| 47 | + arguments: { |
| 48 | + query: { name: "Peter" }, |
| 49 | + }, |
| 50 | + }, |
| 51 | + ]; |
| 52 | + |
| 53 | + for (const testType of ["database", "collection"] as const) { |
| 54 | + describe(`with non-existing ${testType}`, () => { |
| 55 | + for (const testCase of testCases) { |
| 56 | + it(`should return the explain plan for ${testCase.method}`, async () => { |
| 57 | + if (testType === "database") { |
| 58 | + const { databases } = await integration.mongoClient().db("").admin().listDatabases(); |
| 59 | + expect(databases.find((db) => db.name === integration.randomDbName())).toBeUndefined(); |
| 60 | + } else if (testType === "collection") { |
| 61 | + await integration |
| 62 | + .mongoClient() |
| 63 | + .db(integration.randomDbName()) |
| 64 | + .createCollection("some-collection"); |
| 65 | + |
| 66 | + const collections = await integration |
| 67 | + .mongoClient() |
| 68 | + .db(integration.randomDbName()) |
| 69 | + .listCollections() |
| 70 | + .toArray(); |
| 71 | + |
| 72 | + expect(collections.find((collection) => collection.name === "coll1")).toBeUndefined(); |
| 73 | + } |
| 74 | + |
| 75 | + await integration.connectMcpClient(); |
| 76 | + |
| 77 | + const response = await integration.mcpClient().callTool({ |
| 78 | + name: "explain", |
| 79 | + arguments: { |
| 80 | + database: integration.randomDbName(), |
| 81 | + collection: "coll1", |
| 82 | + method: [ |
| 83 | + { |
| 84 | + name: testCase.method, |
| 85 | + arguments: testCase.arguments, |
| 86 | + }, |
| 87 | + ], |
| 88 | + }, |
| 89 | + }); |
| 90 | + |
| 91 | + const content = getResponseElements(response.content); |
| 92 | + expect(content).toHaveLength(2); |
| 93 | + expect(content[0].text).toEqual( |
| 94 | + `Here is some information about the winning plan chosen by the query optimizer for running the given \`${testCase.method}\` operation in "${integration.randomDbName()}.coll1". This information can be used to understand how the query was executed and to optimize the query performance.` |
| 95 | + ); |
| 96 | + |
| 97 | + expect(content[1].text).toContain("queryPlanner"); |
| 98 | + expect(content[1].text).toContain("winningPlan"); |
| 99 | + }); |
| 100 | + } |
| 101 | + }); |
| 102 | + } |
| 103 | + |
| 104 | + describe("with existing database and collection", () => { |
| 105 | + for (const indexed of [true, false] as const) { |
| 106 | + describe(`with ${indexed ? "an index" : "no index"}`, () => { |
| 107 | + beforeEach(async () => { |
| 108 | + await integration |
| 109 | + .mongoClient() |
| 110 | + .db(integration.randomDbName()) |
| 111 | + .collection("people") |
| 112 | + .insertMany([{ name: "Alice" }, { name: "Bob" }, { name: "Charlie" }]); |
| 113 | + |
| 114 | + if (indexed) { |
| 115 | + await integration |
| 116 | + .mongoClient() |
| 117 | + .db(integration.randomDbName()) |
| 118 | + .collection("people") |
| 119 | + .createIndex({ name: 1 }); |
| 120 | + } |
| 121 | + }); |
| 122 | + |
| 123 | + for (const testCase of testCases) { |
| 124 | + it(`should return the explain plan for ${testCase.method}`, async () => { |
| 125 | + await integration.connectMcpClient(); |
| 126 | + |
| 127 | + const response = await integration.mcpClient().callTool({ |
| 128 | + name: "explain", |
| 129 | + arguments: { |
| 130 | + database: integration.randomDbName(), |
| 131 | + collection: "people", |
| 132 | + method: [ |
| 133 | + { |
| 134 | + name: testCase.method, |
| 135 | + arguments: testCase.arguments, |
| 136 | + }, |
| 137 | + ], |
| 138 | + }, |
| 139 | + }); |
| 140 | + |
| 141 | + const content = getResponseElements(response.content); |
| 142 | + expect(content).toHaveLength(2); |
| 143 | + expect(content[0].text).toEqual( |
| 144 | + `Here is some information about the winning plan chosen by the query optimizer for running the given \`${testCase.method}\` operation in "${integration.randomDbName()}.people". This information can be used to understand how the query was executed and to optimize the query performance.` |
| 145 | + ); |
| 146 | + |
| 147 | + expect(content[1].text).toContain("queryPlanner"); |
| 148 | + expect(content[1].text).toContain("winningPlan"); |
| 149 | + |
| 150 | + if (indexed) { |
| 151 | + if (testCase.method === "count") { |
| 152 | + expect(content[1].text).toContain("COUNT_SCAN"); |
| 153 | + } else { |
| 154 | + expect(content[1].text).toContain("IXSCAN"); |
| 155 | + } |
| 156 | + expect(content[1].text).toContain("name_1"); |
| 157 | + } else { |
| 158 | + expect(content[1].text).toContain("COLLSCAN"); |
| 159 | + } |
| 160 | + }); |
| 161 | + } |
| 162 | + }); |
| 163 | + } |
| 164 | + }); |
| 165 | + |
| 166 | + validateAutoConnectBehavior(integration, "explain", () => { |
| 167 | + return { |
| 168 | + args: { database: integration.randomDbName(), collection: "coll1", method: [] }, |
| 169 | + expectedResponse: "No method provided. Expected one of the following: `aggregate`, `find`, or `count`", |
| 170 | + }; |
| 171 | + }); |
| 172 | +}); |
0 commit comments