Skip to content

chore: moving common classes into src/common #356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 11, 2025
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
4 changes: 2 additions & 2 deletions src/common/atlas/apiClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import { AccessToken, ClientCredentials } from "simple-oauth2";
import { ApiClientError } from "./apiClientError.js";
import { paths, operations } from "./openapi.js";
import { CommonProperties, TelemetryEvent } from "../../telemetry/types.js";
import { packageInfo } from "../../helpers/packageInfo.js";
import logger, { LogId } from "../../logger.js";
import { packageInfo } from "../packageInfo.js";
import logger, { LogId } from "../logger.js";

const ATLAS_API_VERSION = "2025-03-12";

Expand Down
2 changes: 1 addition & 1 deletion src/common/atlas/cluster.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { ClusterDescription20240805, FlexClusterDescription20241113 } from "./openapi.js";
import { ApiClient } from "./apiClient.js";
import logger, { LogId } from "../../logger.js";
import logger, { LogId } from "../logger.js";

export interface Cluster {
name?: string;
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
6 changes: 3 additions & 3 deletions src/session.ts → src/common/session.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { NodeDriverServiceProvider } from "@mongosh/service-provider-node-driver";
import { ApiClient, ApiClientCredentials } from "./common/atlas/apiClient.js";
import { ApiClient, ApiClientCredentials } from "./atlas/apiClient.js";
import { Implementation } from "@modelcontextprotocol/sdk/types.js";
import logger, { LogId } from "./logger.js";
import EventEmitter from "events";
import { ConnectOptions } from "./config.js";
import { setAppNameParamIfMissing } from "./helpers/connectionOptions.js";
import { packageInfo } from "./helpers/packageInfo.js";
import { setAppNameParamIfMissing } from "../helpers/connectionOptions.js";
import { packageInfo } from "./packageInfo.js";

export interface SessionOptions {
apiBaseUrl: string;
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion src/helpers/indexCheck.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Document } from "mongodb";
import { NodeDriverServiceProvider } from "@mongosh/service-provider-node-driver";
import { ErrorCodes, MongoDBError } from "../errors.js";
import { ErrorCodes, MongoDBError } from "../common/errors.js";

/**
* Check if the query plan uses an index
Expand Down
8 changes: 4 additions & 4 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
#!/usr/bin/env node

import logger, { LogId } from "./logger.js";
import logger, { LogId } from "./common/logger.js";
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { config } from "./config.js";
import { Session } from "./session.js";
import { config } from "./common/config.js";
import { Session } from "./common/session.js";
import { Server } from "./server.js";
import { packageInfo } from "./helpers/packageInfo.js";
import { packageInfo } from "./common/packageInfo.js";
import { Telemetry } from "./telemetry/telemetry.js";
import { createEJsonTransport } from "./helpers/EJsonTransport.js";

Expand Down
8 changes: 4 additions & 4 deletions src/server.ts
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { Session } from "./session.js";
import { Session } from "./common/session.js";
import { Transport } from "@modelcontextprotocol/sdk/shared/transport.js";
import { AtlasTools } from "./tools/atlas/tools.js";
import { MongoDbTools } from "./tools/mongodb/tools.js";
import logger, { setStdioPreset, setContainerPreset, LogId } from "./logger.js";
import logger, { setStdioPreset, setContainerPreset, LogId } from "./common/logger.js";
import { ObjectId } from "mongodb";
import { Telemetry } from "./telemetry/telemetry.js";
import { UserConfig } from "./config.js";
import { UserConfig } from "./common/config.js";
import { type ServerEvent } from "./telemetry/types.js";
import { type ServerCommand } from "./telemetry/types.js";
import { CallToolRequestSchema, CallToolResult } from "@modelcontextprotocol/sdk/types.js";
import assert from "assert";
import { detectContainerEnv } from "./common/container.js";
import { detectContainerEnv } from "./helpers/container.js";
import { ToolBase } from "./tools/tool.js";

export interface ServerOptions {
Expand Down
2 changes: 1 addition & 1 deletion src/telemetry/constants.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { packageInfo } from "../helpers/packageInfo.js";
import { packageInfo } from "../common/packageInfo.js";
import { type CommonStaticProperties } from "./types.js";

/**
Expand Down
8 changes: 4 additions & 4 deletions src/telemetry/telemetry.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import { Session } from "../session.js";
import { Session } from "../common/session.js";
import { BaseEvent, CommonProperties } from "./types.js";
import { UserConfig } from "../config.js";
import logger, { LogId } from "../logger.js";
import { UserConfig } from "../common/config.js";
import logger, { LogId } from "../common/logger.js";
import { ApiClient } from "../common/atlas/apiClient.js";
import { MACHINE_METADATA } from "./constants.js";
import { EventCache } from "./eventCache.js";
import nodeMachineId from "node-machine-id";
import { getDeviceId } from "@mongodb-js/device-id";
import { detectContainerEnv } from "../common/container.js";
import { detectContainerEnv } from "../helpers/container.js";

type EventResult = {
success: boolean;
Expand Down
2 changes: 1 addition & 1 deletion src/tools/atlas/atlasTool.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { ToolBase, ToolCategory, TelemetryToolMetadata, ToolArgs } from "../tool.js";
import { ToolCallback } from "@modelcontextprotocol/sdk/server/mcp.js";
import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
import logger, { LogId } from "../../logger.js";
import logger, { LogId } from "../../common/logger.js";
import { z } from "zod";
import { ApiClientError } from "../../common/atlas/apiClientError.js";

Expand Down
4 changes: 2 additions & 2 deletions src/tools/atlas/connect/connectCluster.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import { z } from "zod";
import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
import { AtlasToolBase } from "../atlasTool.js";
import { ToolArgs, OperationType } from "../../tool.js";
import { generateSecurePassword } from "../../../common/atlas/generatePassword.js";
import logger, { LogId } from "../../../logger.js";
import { generateSecurePassword } from "../../../helpers/generatePassword.js";
import logger, { LogId } from "../../../common/logger.js";
import { inspectCluster } from "../../../common/atlas/cluster.js";

const EXPIRY_MS = 1000 * 60 * 60 * 12; // 12 hours
Expand Down
2 changes: 1 addition & 1 deletion src/tools/atlas/create/createDBUser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
import { AtlasToolBase } from "../atlasTool.js";
import { ToolArgs, OperationType } from "../../tool.js";
import { CloudDatabaseUser, DatabaseUserRole } from "../../../common/atlas/openapi.js";
import { generateSecurePassword } from "../../../common/atlas/generatePassword.js";
import { generateSecurePassword } from "../../../helpers/generatePassword.js";

export class CreateDBUserTool extends AtlasToolBase {
public name = "atlas-create-db-user";
Expand Down
4 changes: 2 additions & 2 deletions src/tools/mongodb/connect/connect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
import { MongoDBToolBase } from "../mongodbTool.js";
import { ToolArgs, OperationType } from "../../tool.js";
import assert from "assert";
import { UserConfig } from "../../../config.js";
import { UserConfig } from "../../../common/config.js";
import { Telemetry } from "../../../telemetry/telemetry.js";
import { Session } from "../../../session.js";
import { Session } from "../../../common/session.js";
import { Server } from "../../../server.js";

const disconnectedSchema = z
Expand Down
4 changes: 2 additions & 2 deletions src/tools/mongodb/mongodbTool.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import { z } from "zod";
import { ToolArgs, ToolBase, ToolCategory, TelemetryToolMetadata } from "../tool.js";
import { NodeDriverServiceProvider } from "@mongosh/service-provider-node-driver";
import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
import { ErrorCodes, MongoDBError } from "../../errors.js";
import logger, { LogId } from "../../logger.js";
import { ErrorCodes, MongoDBError } from "../../common/errors.js";
import logger, { LogId } from "../../common/logger.js";
import { Server } from "../../server.js";

export const DbOperationArgs = {
Expand Down
6 changes: 3 additions & 3 deletions src/tools/tool.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { z, type ZodRawShape, type ZodNever, AnyZodObject } from "zod";
import type { RegisteredTool, ToolCallback } from "@modelcontextprotocol/sdk/server/mcp.js";
import type { CallToolResult, ToolAnnotations } from "@modelcontextprotocol/sdk/types.js";
import { Session } from "../session.js";
import logger, { LogId } from "../logger.js";
import { Session } from "../common/session.js";
import logger, { LogId } from "../common/logger.js";
import { Telemetry } from "../telemetry/telemetry.js";
import { type ToolEvent } from "../telemetry/types.js";
import { UserConfig } from "../config.js";
import { UserConfig } from "../common/config.js";
import { Server } from "../server.js";

export type ToolArgs<Args extends ZodRawShape> = z.objectOutputType<Args, ZodNever>;
Expand Down
6 changes: 3 additions & 3 deletions tests/integration/helpers.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import { Client } from "@modelcontextprotocol/sdk/client/index.js";
import { InMemoryTransport } from "./inMemoryTransport.js";
import { Server } from "../../src/server.js";
import { UserConfig } from "../../src/config.js";
import { UserConfig } from "../../src/common/config.js";
import { McpError } from "@modelcontextprotocol/sdk/types.js";
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { Session } from "../../src/session.js";
import { Session } from "../../src/common/session.js";
import { Telemetry } from "../../src/telemetry/telemetry.js";
import { config } from "../../src/config.js";
import { config } from "../../src/common/config.js";
import { jest } from "@jest/globals";

interface ParameterInfo {
Expand Down
4 changes: 2 additions & 2 deletions tests/integration/telemetry.test.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { createHmac } from "crypto";
import { Telemetry } from "../../src/telemetry/telemetry.js";
import { Session } from "../../src/session.js";
import { config } from "../../src/config.js";
import { Session } from "../../src/common/session.js";
import { config } from "../../src/common/config.js";
import nodeMachineId from "node-machine-id";

describe("Telemetry", () => {
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/tools/atlas/clusters.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Session } from "../../../../src/session.js";
import { Session } from "../../../../src/common/session.js";
import { expectDefined, getResponseElements } from "../../helpers.js";
import { describeWithAtlas, withProject, randomId } from "./atlasHelpers.js";
import { ClusterDescription20240805 } from "../../../../src/common/atlas/openapi.js";
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/tools/mongodb/connect/connect.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import {
validateThrowsForInvalidArguments,
validateToolMetadata,
} from "../../../helpers.js";
import { config } from "../../../../../src/config.js";
import { config } from "../../../../../src/common/config.js";
import { defaultTestConfig, setupIntegrationTest } from "../../../helpers.js";

describeWithMongoDB(
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/tools/mongodb/mongodbHelpers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { fileURLToPath } from "url";
import fs from "fs/promises";
import { MongoClient, ObjectId } from "mongodb";
import { getResponseContent, IntegrationTest, setupIntegrationTest, defaultTestConfig } from "../../helpers.js";
import { UserConfig } from "../../../../src/config.js";
import { UserConfig } from "../../../../src/common/config.js";

const __dirname = path.dirname(fileURLToPath(import.meta.url));

Expand Down
4 changes: 2 additions & 2 deletions tests/unit/session.test.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { jest } from "@jest/globals";
import { NodeDriverServiceProvider } from "@mongosh/service-provider-node-driver";
import { Session } from "../../src/session.js";
import { config } from "../../src/config.js";
import { Session } from "../../src/common/session.js";
import { config } from "../../src/common/config.js";

jest.mock("@mongosh/service-provider-node-driver");
const MockNodeDriverServiceProvider = NodeDriverServiceProvider as jest.MockedClass<typeof NodeDriverServiceProvider>;
Expand Down
6 changes: 3 additions & 3 deletions tests/unit/telemetry.test.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { ApiClient } from "../../src/common/atlas/apiClient.js";
import { Session } from "../../src/session.js";
import { Session } from "../../src/common/session.js";
import { DEVICE_ID_TIMEOUT, Telemetry } from "../../src/telemetry/telemetry.js";
import { BaseEvent, TelemetryResult } from "../../src/telemetry/types.js";
import { EventCache } from "../../src/telemetry/eventCache.js";
import { config } from "../../src/config.js";
import { config } from "../../src/common/config.js";
import { jest } from "@jest/globals";
import logger, { LogId } from "../../src/logger.js";
import logger, { LogId } from "../../src/common/logger.js";
import { createHmac } from "crypto";

// Mock the ApiClient to avoid real API calls
Expand Down
Loading