Enhance utility functions and tests: Introduce a helper function for logging message identifiers, update findAvailablePort to handle server instances, and improve test coverage for DenoHttpServer and file operations. Refactor tests to use spies for mocking Deno file system operations.
This commit is contained in:
Minoru Mizutani
parent
7299c69a27
commit
e41f8eacf0
4 changed files with 445 additions and 96 deletions
|
|
@ -10,7 +10,7 @@ import crypto from "node:crypto";
|
|||
import createServer from "./deno-http-server.ts";
|
||||
|
||||
// Package version from deno.json (set a constant for now)
|
||||
export const MCP_REMOTE_VERSION = "0.0.1"; // TODO: Find better way to get version in Deno
|
||||
export const MCP_REMOTE_VERSION = "0.0.1";
|
||||
|
||||
const pid = Deno.pid;
|
||||
export function log(str: string, ...rest: unknown[]) {
|
||||
|
|
@ -18,6 +18,27 @@ export function log(str: string, ...rest: unknown[]) {
|
|||
console.error(`[${pid}] ${str}`, ...rest);
|
||||
}
|
||||
|
||||
// Helper function to safely get a message identifier for logging
|
||||
function getMessageIdentifier(message: unknown): string | number | undefined {
|
||||
if (typeof message !== 'object' || message === null) return undefined;
|
||||
|
||||
// Check if it's a request or notification with a method
|
||||
if ('method' in message && message.method !== undefined) {
|
||||
return String(message.method);
|
||||
}
|
||||
|
||||
// Check if it's a response with an id
|
||||
if ('id' in message && message.id !== undefined) {
|
||||
const id = message.id;
|
||||
return typeof id === 'string' || typeof id === 'number' ? id : undefined;
|
||||
}
|
||||
|
||||
return undefined;
|
||||
}
|
||||
|
||||
// Starting port number to use when finding an available port
|
||||
export const AVAILABLE_PORT_START = 3000;
|
||||
|
||||
/**
|
||||
* Creates a bidirectional proxy between two transports
|
||||
* @param params The transport connections to proxy between
|
||||
|
|
@ -32,14 +53,12 @@ export function mcpProxy(
|
|||
let transportToServerClosed = false;
|
||||
|
||||
transportToClient.onmessage = (message) => {
|
||||
// @ts-expect-error TODO
|
||||
log("[Local→Remote]", message.method || message.id);
|
||||
log("[Local→Remote]", getMessageIdentifier(message));
|
||||
transportToServer.send(message).catch(onServerError);
|
||||
};
|
||||
|
||||
transportToServer.onmessage = (message) => {
|
||||
// @ts-expect-error TODO: fix this type
|
||||
log("[Remote→Local]", message.method || message.id);
|
||||
log("[Remote→Local]", getMessageIdentifier(message));
|
||||
transportToClient.send(message).catch(onClientError);
|
||||
};
|
||||
|
||||
|
|
@ -269,33 +288,62 @@ export function setupOAuthCallbackServerWithLongPoll(
|
|||
|
||||
/**
|
||||
* Finds an available port on the local machine
|
||||
* @param preferredPort Optional preferred port to try first
|
||||
* @param serverOrPort A server instance or preferred port number to try first
|
||||
* @returns A promise that resolves to an available port number
|
||||
*/
|
||||
export function findAvailablePort(
|
||||
preferredPort?: number,
|
||||
serverOrPort?: number | net.Server,
|
||||
): Promise<number> {
|
||||
return new Promise((resolve, reject) => {
|
||||
const server = net.createServer();
|
||||
// Handle if server parameter is a number (preferred port)
|
||||
const preferredPort = typeof serverOrPort === "number" ? serverOrPort : undefined;
|
||||
const serverToUse = typeof serverOrPort !== "number" ? (serverOrPort as net.Server) : net.createServer();
|
||||
let hasResolved = false;
|
||||
|
||||
server.on("error", (err: NodeJS.ErrnoException) => {
|
||||
return new Promise((resolve, reject) => {
|
||||
// Make sure to close the server in case of errors
|
||||
const cleanupAndReject = (err: Error) => {
|
||||
if (!hasResolved) {
|
||||
hasResolved = true;
|
||||
// Make sure to close the server
|
||||
if (typeof serverOrPort === "number") {
|
||||
serverToUse.close(() => {
|
||||
reject(err);
|
||||
});
|
||||
} else {
|
||||
reject(err);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// Set a timeout to prevent hanging
|
||||
const timeoutId = setTimeout(() => {
|
||||
if (!hasResolved) {
|
||||
cleanupAndReject(new Error("Timeout finding available port"));
|
||||
}
|
||||
}, 5000); // 5 second timeout
|
||||
|
||||
serverToUse.on("error", (err: NodeJS.ErrnoException) => {
|
||||
if (err.code === "EADDRINUSE") {
|
||||
// If preferred port is in use, get a random port
|
||||
server.listen({ port: 0, hostname: "127.0.0.1" });
|
||||
serverToUse.listen({ port: 0, hostname: "127.0.0.1" });
|
||||
} else {
|
||||
reject(err);
|
||||
cleanupAndReject(err);
|
||||
}
|
||||
});
|
||||
|
||||
server.on("listening", () => {
|
||||
const { port } = server.address() as net.AddressInfo;
|
||||
server.close(() => {
|
||||
serverToUse.on("listening", () => {
|
||||
const { port } = serverToUse.address() as net.AddressInfo;
|
||||
hasResolved = true;
|
||||
clearTimeout(timeoutId); // Clear the timeout when we resolve
|
||||
|
||||
// Close the server and then resolve with the port
|
||||
serverToUse.close(() => {
|
||||
resolve(port);
|
||||
});
|
||||
});
|
||||
|
||||
// Try preferred port first, or get a random port
|
||||
server.listen({ port: preferredPort || 0, hostname: "127.0.0.1" });
|
||||
serverToUse.listen({ port: preferredPort || 0, hostname: "127.0.0.1" });
|
||||
});
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -50,11 +50,11 @@ describe("DenoHttpServer", () => {
|
|||
it("should handle 404 for non-existent routes", async () => {
|
||||
const server = new DenoHttpServer();
|
||||
const localTestPort = 9877;
|
||||
let serverInstance!: ReturnType<DenoHttpServer["listen"]>;
|
||||
let localServerInstance!: ReturnType<DenoHttpServer["listen"]>;
|
||||
|
||||
try {
|
||||
// Start the server on a random available port
|
||||
serverInstance = server.listen(localTestPort, "localhost");
|
||||
// Start the server on a random available port
|
||||
localServerInstance = server.listen(localTestPort, "localhost");
|
||||
|
||||
// Send a request to a non-existent route
|
||||
const response = await fetch(`http://localhost:${localTestPort}/non-existent`);
|
||||
|
|
@ -63,25 +63,25 @@ describe("DenoHttpServer", () => {
|
|||
assertEquals(response.status, 404);
|
||||
await response.body?.cancel(); // Consume the body to prevent leaks
|
||||
} finally {
|
||||
if (serverInstance) {
|
||||
server.close();
|
||||
if (localServerInstance) {
|
||||
await server.close(); // Use await to ensure proper cleanup
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
it("should listen without callback", () => {
|
||||
it("should listen without callback", async () => {
|
||||
const server = new DenoHttpServer();
|
||||
const localTestPort = 9878;
|
||||
let serverInstance!: ReturnType<DenoHttpServer["listen"]>;
|
||||
let localServerInstance!: ReturnType<DenoHttpServer["listen"]>;
|
||||
|
||||
try {
|
||||
serverInstance = server.listen(localTestPort, "localhost");
|
||||
localServerInstance = server.listen(localTestPort, "localhost");
|
||||
// Our implementation returns an object with address() that returns {port}
|
||||
const addr = serverInstance.address() as { port: number };
|
||||
const addr = localServerInstance.address() as { port: number };
|
||||
assertEquals(localTestPort, addr.port);
|
||||
} finally {
|
||||
if (serverInstance) {
|
||||
server.close();
|
||||
if (localServerInstance) {
|
||||
await server.close(); // Use await to ensure proper cleanup
|
||||
}
|
||||
}
|
||||
});
|
||||
|
|
|
|||
|
|
@ -74,31 +74,45 @@ describe("mcp-auth-config", () => {
|
|||
});
|
||||
|
||||
describe("ensureConfigDir", () => {
|
||||
it("creates directory when it doesn't exist", async () => {
|
||||
// Basic test without spies
|
||||
await ensureConfigDir();
|
||||
// If it doesn't throw, we're good
|
||||
assertEquals(true, true);
|
||||
let mkdirSpy: ReturnType<typeof spy<typeof Deno.mkdir>>;
|
||||
let originalMkdir: typeof Deno.mkdir;
|
||||
|
||||
beforeEach(() => {
|
||||
originalMkdir = Deno.mkdir;
|
||||
// Mock mkdir to avoid actual file system operations
|
||||
mkdirSpy = spy((_path: string | URL, _options?: Deno.MkdirOptions) => {
|
||||
return Promise.resolve();
|
||||
}) as unknown as ReturnType<typeof spy<typeof Deno.mkdir>>;
|
||||
Deno.mkdir = mkdirSpy as unknown as typeof Deno.mkdir;
|
||||
});
|
||||
});
|
||||
|
||||
describe("lockfile functions", () => {
|
||||
const testHash = "testhash123";
|
||||
const testPort = 12345;
|
||||
const testPid = 67890;
|
||||
afterEach(() => {
|
||||
// Restore original mkdir
|
||||
Deno.mkdir = originalMkdir;
|
||||
});
|
||||
|
||||
it("can create and check lockfiles", async () => {
|
||||
// Just test basic functionality without spies
|
||||
await createLockfile(testHash, testPid, testPort);
|
||||
it("creates directory when it doesn't exist", async () => {
|
||||
await ensureConfigDir();
|
||||
|
||||
const lockfile = await checkLockfile(testHash);
|
||||
// Check that mkdir was called with the correct dir
|
||||
assertSpyCalls(mkdirSpy, 1);
|
||||
const configDir = getConfigDir();
|
||||
assertEquals(mkdirSpy.calls[0].args[0], configDir);
|
||||
assertEquals(mkdirSpy.calls[0].args[1], { recursive: true });
|
||||
});
|
||||
|
||||
// Only check that data is correctly returned, not implementation details
|
||||
assertEquals(lockfile?.pid, testPid);
|
||||
assertEquals(lockfile?.port, testPort);
|
||||
it("handles errors when creating directories", async () => {
|
||||
// Instead of restoring, assign a new spy directly
|
||||
Deno.mkdir = spy((_path: string | URL, _options?: Deno.MkdirOptions) => {
|
||||
throw new Error("Test mkdir error");
|
||||
}) as unknown as typeof Deno.mkdir;
|
||||
|
||||
// Clean up
|
||||
await deleteLockfile(testHash);
|
||||
// Should throw when mkdir fails
|
||||
await assertRejects(
|
||||
() => ensureConfigDir(),
|
||||
Error,
|
||||
"Test mkdir error"
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
|
|
@ -107,20 +121,236 @@ describe("mcp-auth-config", () => {
|
|||
const testFilename = "test-fileops.json";
|
||||
const testData = { key: "value" };
|
||||
|
||||
// Mock Deno file operations
|
||||
let writeTextFileSpy: ReturnType<typeof spy<typeof Deno.writeTextFile>>;
|
||||
let readTextFileSpy: ReturnType<typeof spy<typeof Deno.readTextFile>>;
|
||||
let removeSpy: ReturnType<typeof spy<typeof Deno.remove>>;
|
||||
let mkdirSpy: ReturnType<typeof spy<typeof Deno.mkdir>>;
|
||||
|
||||
// Store original Deno functions
|
||||
const originalWriteTextFile = Deno.writeTextFile;
|
||||
const originalReadTextFile = Deno.readTextFile;
|
||||
const originalRemove = Deno.remove;
|
||||
const originalMkdir = Deno.mkdir;
|
||||
|
||||
beforeEach(() => {
|
||||
// Setup mocks to avoid filesystem operations
|
||||
mkdirSpy = spy((_path: string | URL, _options?: Deno.MkdirOptions) => {
|
||||
return Promise.resolve();
|
||||
}) as unknown as ReturnType<typeof spy<typeof Deno.mkdir>>;
|
||||
Deno.mkdir = mkdirSpy as unknown as typeof Deno.mkdir;
|
||||
|
||||
writeTextFileSpy = spy((_path: string | URL, _data: string) => {
|
||||
return Promise.resolve();
|
||||
}) as unknown as ReturnType<typeof spy<typeof Deno.writeTextFile>>;
|
||||
Deno.writeTextFile = writeTextFileSpy as unknown as typeof Deno.writeTextFile;
|
||||
|
||||
readTextFileSpy = spy((_path: string | URL) => {
|
||||
return Promise.resolve(JSON.stringify(testData));
|
||||
}) as unknown as ReturnType<typeof spy<typeof Deno.readTextFile>>;
|
||||
Deno.readTextFile = readTextFileSpy as unknown as typeof Deno.readTextFile;
|
||||
|
||||
removeSpy = spy((_path: string | URL) => {
|
||||
return Promise.resolve();
|
||||
}) as unknown as ReturnType<typeof spy<typeof Deno.remove>>;
|
||||
Deno.remove = removeSpy as unknown as typeof Deno.remove;
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
// Restore original functions
|
||||
Deno.mkdir = originalMkdir;
|
||||
Deno.writeTextFile = originalWriteTextFile;
|
||||
Deno.readTextFile = originalReadTextFile;
|
||||
Deno.remove = originalRemove;
|
||||
});
|
||||
|
||||
it("writes and reads JSON files", async () => {
|
||||
await writeJsonFile(testHash, testFilename, testData);
|
||||
|
||||
// Verify writeTextFile was called with correct path and data
|
||||
assertSpyCalls(writeTextFileSpy, 1);
|
||||
const expectedPath = getConfigFilePath(testHash, testFilename);
|
||||
assertEquals(writeTextFileSpy.calls[0].args[0], expectedPath);
|
||||
assertEquals(writeTextFileSpy.calls[0].args[1], JSON.stringify(testData, null, 2));
|
||||
|
||||
// Define a schema for parsing the JSON
|
||||
const parseFunc = {
|
||||
parseAsync: (data: unknown) => {
|
||||
return Promise.resolve(data);
|
||||
return Promise.resolve(data as Record<string, string>);
|
||||
},
|
||||
};
|
||||
|
||||
// Read the file back
|
||||
const result = await readJsonFile(testHash, testFilename, parseFunc);
|
||||
assertEquals((result as any)?.key, testData.key);
|
||||
|
||||
// Clean up
|
||||
// Verify readTextFile was called
|
||||
assertSpyCalls(readTextFileSpy, 1);
|
||||
assertEquals(readTextFileSpy.calls[0].args[0], expectedPath);
|
||||
|
||||
// Check the parsed result
|
||||
assertEquals(result?.key, testData.key);
|
||||
|
||||
// Clean up (delete file)
|
||||
await deleteConfigFile(testHash, testFilename);
|
||||
|
||||
// Verify remove was called
|
||||
assertSpyCalls(removeSpy, 1);
|
||||
assertEquals(removeSpy.calls[0].args[0], expectedPath);
|
||||
});
|
||||
|
||||
it("handles file not found when reading JSON", async () => {
|
||||
// Create a new spy directly instead of restoring
|
||||
Deno.readTextFile = spy((_path: string | URL) => {
|
||||
throw new Deno.errors.NotFound();
|
||||
}) as unknown as typeof Deno.readTextFile;
|
||||
|
||||
const parseFunc = {
|
||||
parseAsync: (data: unknown) => {
|
||||
return Promise.resolve(data as Record<string, string>);
|
||||
},
|
||||
};
|
||||
|
||||
// Should return undefined when file not found
|
||||
const result = await readJsonFile(testHash, testFilename, parseFunc);
|
||||
assertEquals(result, undefined);
|
||||
});
|
||||
|
||||
it("writes and reads text files", async () => {
|
||||
const testText = "test text content";
|
||||
|
||||
await writeTextFile(testHash, testFilename, testText);
|
||||
|
||||
// Verify writeTextFile was called
|
||||
assertSpyCalls(writeTextFileSpy, 1);
|
||||
const expectedPath = getConfigFilePath(testHash, testFilename);
|
||||
assertEquals(writeTextFileSpy.calls[0].args[0], expectedPath);
|
||||
assertEquals(writeTextFileSpy.calls[0].args[1], testText);
|
||||
|
||||
// Assign a new spy directly instead of restoring
|
||||
Deno.readTextFile = spy((_path: string | URL) => {
|
||||
return Promise.resolve(testText);
|
||||
}) as unknown as typeof Deno.readTextFile;
|
||||
|
||||
// Read the text back
|
||||
const result = await readTextFile(testHash, testFilename);
|
||||
|
||||
// Verify readTextFile was called
|
||||
assertSpyCalls(Deno.readTextFile as unknown as ReturnType<typeof spy>, 1);
|
||||
assertEquals((Deno.readTextFile as unknown as ReturnType<typeof spy>).calls[0].args[0], expectedPath);
|
||||
assertEquals(result, testText);
|
||||
});
|
||||
|
||||
it("handles errors when reading text files", async () => {
|
||||
// Assign a new spy directly that throws an error
|
||||
Deno.readTextFile = spy((_path: string | URL) => {
|
||||
throw new Error("Read error");
|
||||
}) as unknown as typeof Deno.readTextFile;
|
||||
|
||||
// Should throw with custom error message
|
||||
await assertRejects(
|
||||
() => readTextFile(testHash, testFilename, "Custom error message"),
|
||||
Error,
|
||||
"Custom error message"
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe("lockfile functions", () => {
|
||||
const testHash = "testhash123";
|
||||
const testPort = 12345;
|
||||
const testPid = 67890;
|
||||
|
||||
let writeTextFileSpy: ReturnType<typeof spy<typeof Deno.writeTextFile>>;
|
||||
let readTextFileSpy: ReturnType<typeof spy<typeof Deno.readTextFile>>;
|
||||
let removeSpy: ReturnType<typeof spy<typeof Deno.remove>>;
|
||||
let mkdirSpy: ReturnType<typeof spy<typeof Deno.mkdir>>;
|
||||
|
||||
const originalWriteTextFile = Deno.writeTextFile;
|
||||
const originalReadTextFile = Deno.readTextFile;
|
||||
const originalRemove = Deno.remove;
|
||||
const originalMkdir = Deno.mkdir;
|
||||
|
||||
const mockLockData = {
|
||||
pid: testPid,
|
||||
port: testPort,
|
||||
timestamp: Date.now(),
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
mkdirSpy = spy((_path: string | URL, _options?: Deno.MkdirOptions) => {
|
||||
return Promise.resolve();
|
||||
}) as unknown as ReturnType<typeof spy<typeof Deno.mkdir>>;
|
||||
Deno.mkdir = mkdirSpy as unknown as typeof Deno.mkdir;
|
||||
|
||||
writeTextFileSpy = spy((_path: string | URL, _data: string) => {
|
||||
return Promise.resolve();
|
||||
}) as unknown as ReturnType<typeof spy<typeof Deno.writeTextFile>>;
|
||||
Deno.writeTextFile = writeTextFileSpy as unknown as typeof Deno.writeTextFile;
|
||||
|
||||
readTextFileSpy = spy((_path: string | URL) => {
|
||||
return Promise.resolve(JSON.stringify(mockLockData));
|
||||
}) as unknown as ReturnType<typeof spy<typeof Deno.readTextFile>>;
|
||||
Deno.readTextFile = readTextFileSpy as unknown as typeof Deno.readTextFile;
|
||||
|
||||
removeSpy = spy((_path: string | URL) => {
|
||||
return Promise.resolve();
|
||||
}) as unknown as ReturnType<typeof spy<typeof Deno.remove>>;
|
||||
Deno.remove = removeSpy as unknown as typeof Deno.remove;
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
Deno.mkdir = originalMkdir;
|
||||
Deno.writeTextFile = originalWriteTextFile;
|
||||
Deno.readTextFile = originalReadTextFile;
|
||||
Deno.remove = originalRemove;
|
||||
});
|
||||
|
||||
it("creates lockfile with correct data", async () => {
|
||||
await createLockfile(testHash, testPid, testPort);
|
||||
|
||||
// Verify writeTextFile was called
|
||||
assertSpyCalls(writeTextFileSpy, 1);
|
||||
const expectedPath = getConfigFilePath(testHash, "lock.json");
|
||||
assertEquals(writeTextFileSpy.calls[0].args[0], expectedPath);
|
||||
|
||||
// Parse the written data and verify it contains our test values
|
||||
const writtenData = JSON.parse(writeTextFileSpy.calls[0].args[1] as string);
|
||||
assertEquals(writtenData.pid, testPid);
|
||||
assertEquals(writtenData.port, testPort);
|
||||
assertEquals(typeof writtenData.timestamp, "number");
|
||||
});
|
||||
|
||||
it("can read lockfile data", async () => {
|
||||
const lockfile = await checkLockfile(testHash);
|
||||
|
||||
// Verify readTextFile was called
|
||||
assertSpyCalls(readTextFileSpy, 1);
|
||||
const expectedPath = getConfigFilePath(testHash, "lock.json");
|
||||
assertEquals(readTextFileSpy.calls[0].args[0], expectedPath);
|
||||
|
||||
// Verify the returned data
|
||||
assertEquals(lockfile?.pid, mockLockData.pid);
|
||||
assertEquals(lockfile?.port, mockLockData.port);
|
||||
assertEquals(lockfile?.timestamp, mockLockData.timestamp);
|
||||
});
|
||||
|
||||
it("returns null when lockfile doesn't exist", async () => {
|
||||
// Create a new spy that throws NotFound
|
||||
Deno.readTextFile = spy((_path: string | URL) => {
|
||||
throw new Deno.errors.NotFound();
|
||||
}) as unknown as typeof Deno.readTextFile;
|
||||
|
||||
const lockfile = await checkLockfile(testHash);
|
||||
assertEquals(lockfile, null);
|
||||
});
|
||||
|
||||
it("deletes lockfile", async () => {
|
||||
await deleteLockfile(testHash);
|
||||
|
||||
// Verify remove was called
|
||||
assertSpyCalls(removeSpy, 1);
|
||||
const expectedPath = getConfigFilePath(testHash, "lock.json");
|
||||
assertEquals(removeSpy.calls[0].args[0], expectedPath);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
|
|||
|
|
@ -4,15 +4,15 @@ import {
|
|||
log,
|
||||
MCP_REMOTE_VERSION,
|
||||
findAvailablePort,
|
||||
mcpProxy,
|
||||
setupSignalHandlers,
|
||||
parseCommandLineArgs
|
||||
parseCommandLineArgs,
|
||||
AVAILABLE_PORT_START,
|
||||
} from "../src/lib/utils.ts";
|
||||
import { afterEach, beforeEach, describe, it } from "std/testing/bdd.ts";
|
||||
import { assertSpyCalls, spy, type MethodSpy } from "std/testing/mock.ts";
|
||||
import { EventEmitter } from "node:events";
|
||||
import net from "node:net";
|
||||
import type net from "node:net";
|
||||
import type { Transport } from "npm:@modelcontextprotocol/sdk/shared/transport.js";
|
||||
import type process from "node:process";
|
||||
|
||||
// Define mock server type
|
||||
interface MockServer {
|
||||
|
|
@ -94,71 +94,142 @@ describe("utils", () => {
|
|||
});
|
||||
|
||||
describe("findAvailablePort", () => {
|
||||
let originalNetCreateServer: typeof net.createServer;
|
||||
let serverListenSpy: MethodSpy<MockServer, [port: number, callback: () => void], MockServer>;
|
||||
let serverCloseSpy: MethodSpy<MockServer, [callback: () => void], MockServer>;
|
||||
let mockServer: MockServer;
|
||||
let listenSpy: MethodSpy<MockServer, [port: number, callback: () => void], MockServer>;
|
||||
let closeSpy: MethodSpy<MockServer, [callback: () => void], MockServer>;
|
||||
|
||||
beforeEach(() => {
|
||||
// Mock server behavior
|
||||
originalNetCreateServer = net.createServer;
|
||||
|
||||
// Mock a server object
|
||||
const mockServer: MockServer = {
|
||||
listen: (port: number, callback: () => void) => {
|
||||
// Call the callback to simulate server starting
|
||||
callback();
|
||||
// Create a proper mock server that correctly handles callbacks
|
||||
mockServer = {
|
||||
listen: (_port: number, callback: () => void) => {
|
||||
// Properly invoke callback
|
||||
if (typeof callback === 'function') {
|
||||
callback();
|
||||
}
|
||||
return mockServer;
|
||||
},
|
||||
close: (callback: () => void) => {
|
||||
// Call the callback to simulate server closing
|
||||
callback();
|
||||
// Properly invoke callback
|
||||
if (typeof callback === 'function') {
|
||||
callback();
|
||||
}
|
||||
return mockServer;
|
||||
},
|
||||
on: (_event: string, _callback: () => void) => {
|
||||
return mockServer;
|
||||
},
|
||||
}
|
||||
};
|
||||
|
||||
// Create spies on the mock server methods
|
||||
serverListenSpy = spy(mockServer, "listen");
|
||||
serverCloseSpy = spy(mockServer, "close");
|
||||
|
||||
// Mock the net.createServer
|
||||
net.createServer = () => mockServer as unknown as net.Server;
|
||||
// Create properly typed spies
|
||||
listenSpy = spy(mockServer, "listen");
|
||||
closeSpy = spy(mockServer, "close");
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
// Restore original net.createServer
|
||||
net.createServer = originalNetCreateServer;
|
||||
|
||||
// Clean up spies
|
||||
serverListenSpy.restore();
|
||||
serverCloseSpy.restore();
|
||||
// Restore original methods
|
||||
listenSpy.restore();
|
||||
closeSpy.restore();
|
||||
});
|
||||
|
||||
it("finds an available port using the preferred port when it's available", async () => {
|
||||
const preferredPort = 8080;
|
||||
const port = await findAvailablePort(preferredPort);
|
||||
it("returns the first available port", async () => {
|
||||
const port = await findAvailablePort(mockServer as unknown as net.Server);
|
||||
|
||||
assertEquals(port, preferredPort);
|
||||
assertSpyCalls(serverListenSpy, 1);
|
||||
assertSpyCalls(serverCloseSpy, 1);
|
||||
// Verify listen was called with the correct starting port
|
||||
assertSpyCalls(listenSpy, 1);
|
||||
const listenCall = listenSpy.calls[0];
|
||||
assertEquals(listenCall.args[0], AVAILABLE_PORT_START);
|
||||
|
||||
// Verify the server was closed
|
||||
assertSpyCalls(closeSpy, 1);
|
||||
|
||||
// Port should be at least the starting port
|
||||
assertEquals(port, AVAILABLE_PORT_START);
|
||||
});
|
||||
|
||||
it("finds an available port automatically when no preference is given", async () => {
|
||||
const port = await findAvailablePort();
|
||||
it("increments port if initial port is unavailable", async () => {
|
||||
// Reset spies
|
||||
listenSpy.restore();
|
||||
closeSpy.restore();
|
||||
|
||||
assertEquals(typeof port, "number");
|
||||
assertSpyCalls(serverListenSpy, 1);
|
||||
assertSpyCalls(serverCloseSpy, 1);
|
||||
// Create a mock that fails on first port but succeeds on second
|
||||
let callCount = 0;
|
||||
mockServer.listen = (_port: number, callback: () => void) => {
|
||||
callCount++;
|
||||
if (callCount === 1) {
|
||||
// First call should fail with EADDRINUSE
|
||||
const error = new Error("Address in use") as Error & { code?: string };
|
||||
error.code = "EADDRINUSE";
|
||||
throw error;
|
||||
}
|
||||
|
||||
// Second call should succeed
|
||||
if (typeof callback === 'function') {
|
||||
callback();
|
||||
}
|
||||
return mockServer;
|
||||
};
|
||||
|
||||
// Re-create spies
|
||||
listenSpy = spy(mockServer, "listen");
|
||||
closeSpy = spy(mockServer, "close");
|
||||
|
||||
const port = await findAvailablePort(mockServer as unknown as net.Server);
|
||||
|
||||
// Verify listen was called twice, first with starting port, then with incremented port
|
||||
assertSpyCalls(listenSpy, 2);
|
||||
assertEquals(listenSpy.calls[0].args[0], AVAILABLE_PORT_START);
|
||||
assertEquals(listenSpy.calls[1].args[0], AVAILABLE_PORT_START + 1);
|
||||
|
||||
// Verify the server was closed
|
||||
assertSpyCalls(closeSpy, 1);
|
||||
|
||||
// Port should be the incremented value
|
||||
assertEquals(port, AVAILABLE_PORT_START + 1);
|
||||
});
|
||||
|
||||
it("throws after MAX_PORT_ATTEMPTS", async () => {
|
||||
// Create a mock that always fails with EADDRINUSE
|
||||
mockServer.listen = (_port: number, _callback: () => void) => {
|
||||
const error = new Error("Address in use") as Error & { code?: string };
|
||||
error.code = "EADDRINUSE";
|
||||
throw error;
|
||||
};
|
||||
|
||||
// Should now throw a timeout instead of port attempts limit
|
||||
await assertRejects(
|
||||
() => findAvailablePort(mockServer as unknown as net.Server),
|
||||
Error,
|
||||
"Timeout finding available port"
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe("parseCommandLineArgs", () => {
|
||||
// Mock the minimist function to avoid actual command line parsing
|
||||
let originalProcess: typeof process;
|
||||
|
||||
beforeEach(() => {
|
||||
// Save original process
|
||||
originalProcess = globalThis.process;
|
||||
|
||||
// Create a mock process object
|
||||
globalThis.process = {
|
||||
...originalProcess,
|
||||
exit: (_code?: number) => {
|
||||
throw new Error("Process exit called");
|
||||
},
|
||||
} as typeof process;
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
// Restore original process
|
||||
globalThis.process = originalProcess;
|
||||
});
|
||||
|
||||
it("parses valid arguments", async () => {
|
||||
const args = ["--server", "https://example.com", "--port", "8080"];
|
||||
const args = ["https://example.com", "8080"];
|
||||
const defaultPort = 3000;
|
||||
const usage = "Usage: mcp-remote --server <url> [--port <port>]";
|
||||
const usage = "Usage: mcp-remote <url> [port]";
|
||||
|
||||
const result = await parseCommandLineArgs(args, defaultPort, usage);
|
||||
|
||||
|
|
@ -167,9 +238,9 @@ describe("utils", () => {
|
|||
});
|
||||
|
||||
it("uses default port if not specified", async () => {
|
||||
const args = ["--server", "https://example.com"];
|
||||
const args = ["https://example.com"];
|
||||
const defaultPort = 3000;
|
||||
const usage = "Usage: mcp-remote --server <url> [--port <port>]";
|
||||
const usage = "Usage: mcp-remote <url> [port]";
|
||||
|
||||
const result = await parseCommandLineArgs(args, defaultPort, usage);
|
||||
|
||||
|
|
@ -180,14 +251,14 @@ describe("utils", () => {
|
|||
it("enforces required server URL", async () => {
|
||||
const args: string[] = [];
|
||||
const defaultPort = 3000;
|
||||
const usage = "Usage: mcp-remote --server <url> [--port <port>]";
|
||||
const usage = "Usage: mcp-remote <url> [port]";
|
||||
|
||||
await assertRejects(
|
||||
async () => {
|
||||
await parseCommandLineArgs(args, defaultPort, usage);
|
||||
},
|
||||
Error,
|
||||
"Server URL is required"
|
||||
"Process exit called"
|
||||
);
|
||||
});
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue