Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 9 additions & 16 deletions src/tools/mongodb/metadata/logs.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
import { MongoDBToolBase } from "../mongodbTool.js";
import type { ToolArgs, OperationType } from "../../tool.js";
import { type ToolArgs, type OperationType, formatUntrustedData } from "../../tool.js";
import { z } from "zod";

export class LogsTool extends MongoDBToolBase {
Expand Down Expand Up @@ -33,23 +33,16 @@ export class LogsTool extends MongoDBToolBase {
getLog: type,
});

const logs = (result.log as string[]).slice(0, limit);
// Trim ending newlines so that when we join the logs we don't insert empty lines
// between messages.
const logs = (result.log as string[]).slice(0, limit).map((l) => l.trimEnd());

let message = `Found: ${result.totalLinesWritten} messages`;
if (result.totalLinesWritten > limit) {
message += ` (showing only the first ${limit})`;
}
return {
content: [
{
text: `Found: ${result.totalLinesWritten} messages`,
type: "text",
},

...logs.map(
(log) =>
({
text: log,
type: "text",
}) as const
),
],
content: formatUntrustedData(message, logs.join("\n")),
};
}
}
42 changes: 35 additions & 7 deletions tests/integration/tools/mongodb/metadata/logs.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
import { expect, it } from "vitest";
import { validateToolMetadata, validateThrowsForInvalidArguments, getResponseElements } from "../../../helpers.js";
import {
validateToolMetadata,
validateThrowsForInvalidArguments,
getResponseElements,
getDataFromUntrustedContent,
} from "../../../helpers.js";
import { describeWithMongoDB, validateAutoConnectBehavior } from "../mongodbHelpers.js";

describeWithMongoDB("logs tool", (integration) => {
Expand Down Expand Up @@ -36,13 +41,27 @@ describeWithMongoDB("logs tool", (integration) => {

const elements = getResponseElements(response);

expect(elements).toHaveLength(2);
expect(elements[1]?.text).toContain("<untrusted-user-data-");

const logs = getDataFromUntrustedContent(elements[1]?.text ?? "").split("\n");
Copy link

Copilot AI Sep 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The split('\n') operation may produce empty strings at the end if the logs data ends with newlines. This could cause the length checks and JSON parsing to fail. Consider filtering out empty strings: getDataFromUntrustedContent(elements[1]?.text ?? "").split("\n").filter(line => line.trim())

Suggested change
const logs = getDataFromUntrustedContent(elements[1]?.text ?? "").split("\n");
const logs = getDataFromUntrustedContent(elements[1]?.text ?? "")
.split("\n")
.filter(line => line.trim());

Copilot uses AI. Check for mistakes.

// Default limit is 50
expect(elements.length).toBeLessThanOrEqual(51);
expect(logs.length).toBeLessThanOrEqual(50);

// Expect at least one log entry
expect(logs.length).toBeGreaterThan(1);

expect(elements[0]?.text).toMatch(/Found: \d+ messages/);
const totalMessages = parseInt(elements[0]?.text.match(/Found: (\d+) messages/)?.[1] ?? "0", 10);
expect(totalMessages).toBeGreaterThanOrEqual(logs.length);

if (totalMessages > logs.length) {
expect(elements[0]?.text).toContain(`(showing only the first ${logs.length})`);
}

for (let i = 1; i < elements.length; i++) {
for (const message of logs) {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
const log = JSON.parse(elements[i]?.text ?? "{}");
const log = JSON.parse(message ?? "{}");
expect(log).toHaveProperty("t");
expect(log).toHaveProperty("msg");
}
Expand All @@ -58,9 +77,18 @@ describeWithMongoDB("logs tool", (integration) => {
});

const elements = getResponseElements(response);
expect(elements.length).toBeLessThanOrEqual(51);
for (let i = 1; i < elements.length; i++) {
const log = JSON.parse(elements[i]?.text ?? "{}") as { tags: string[] };
expect(elements).toHaveLength(2);
expect(elements[1]?.text).toContain("<untrusted-user-data-");

const logs = getDataFromUntrustedContent(elements[1]?.text ?? "").split("\n");
Copy link

Copilot AI Sep 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same issue as above - the split('\n') operation may produce empty strings that could break JSON parsing. Consider filtering out empty strings: getDataFromUntrustedContent(elements[1]?.text ?? "").split("\n").filter(line => line.trim())

Suggested change
const logs = getDataFromUntrustedContent(elements[1]?.text ?? "").split("\n");
const logs = getDataFromUntrustedContent(elements[1]?.text ?? "")
.split("\n")
.filter(line => line.trim());

Copilot uses AI. Check for mistakes.

// Default limit is 50
expect(logs.length).toBeLessThanOrEqual(50);

// Expect at least one log entry
expect(logs.length).toBeGreaterThan(1);

for (const message of logs) {
const log = JSON.parse(message ?? "{}") as { tags: string[] };
expect(log).toHaveProperty("t");
expect(log).toHaveProperty("msg");
expect(log).toHaveProperty("tags");
Expand Down
Loading