skybridge 0.0.0-dev.ecf87cf → 0.0.0-dev.ed005a8

package/dist/server/middleware.test.js

@@ -0,0 +1,601 @@
+import { Client, InMemoryTransport } from "@modelcontextprotocol/client";
+import { describe, expect, it, vi } from "vitest";
+import { z } from "zod";
+import { Skybridge } from "./app.js";
+import { buildMiddlewareChain, getHandlerMaps, getToolError, matchesFilter, } from "./middleware.js";
+// ---------------------------------------------------------------------------
+// matchesFilter
+// ---------------------------------------------------------------------------
+describe("matchesFilter", () => {
+    it("matches exact method", () => {
+        expect(matchesFilter("tools/call", "tools/call", false)).toBe(true);
+    });
+    it("rejects non-matching exact method", () => {
+        expect(matchesFilter("tools/list", "tools/call", false)).toBe(false);
+    });
+    it("matches wildcard", () => {
+        expect(matchesFilter("tools/call", "tools/*", false)).toBe(true);
+        expect(matchesFilter("tools/list", "tools/*", false)).toBe(true);
+    });
+    it("rejects non-matching wildcard", () => {
+        expect(matchesFilter("resources/read", "tools/*", false)).toBe(false);
+    });
+    it('category "request" matches when isNotification=false', () => {
+        expect(matchesFilter("tools/call", "request", false)).toBe(true);
+    });
+    it('category "request" rejects when isNotification=true', () => {
+        expect(matchesFilter("notifications/initialized", "request", true)).toBe(false);
+    });
+    it('category "notification" matches when isNotification=true', () => {
+        expect(matchesFilter("notifications/initialized", "notification", true)).toBe(true);
+    });
+    it('category "notification" rejects when isNotification=false', () => {
+        expect(matchesFilter("tools/call", "notification", false)).toBe(false);
+    });
+});
+// ---------------------------------------------------------------------------
+// buildMiddlewareChain
+// ---------------------------------------------------------------------------
+describe("buildMiddlewareChain", () => {
+    const fakeExtra = {};
+    const makeHandler = (returnValue) => vi.fn(async () => returnValue);
+    const makeEntry = (filter, handler) => ({ filter, handler });
+    it("returns original handler when no middleware applies", () => {
+        const original = makeHandler("result");
+        const chain = buildMiddlewareChain("tools/call", false, original, [
+            makeEntry("resources/*", async (_req, _extra, next) => next()),
+        ]);
+        expect(chain).toBe(original);
+    });
+    it("catch-all middleware runs for any method", async () => {
+        const original = makeHandler("ok");
+        const spy = vi.fn();
+        const chain = buildMiddlewareChain("tools/call", false, original, [
+            makeEntry(null, async (request, _extra, next) => {
+                spy(request.method);
+                return next();
+            }),
+        ]);
+        const result = await chain({ method: "tools/call", params: {} }, fakeExtra);
+        expect(spy).toHaveBeenCalledWith("tools/call");
+        expect(result).toBe("ok");
+    });
+    it("method-scoped middleware only runs for matching methods", async () => {
+        const original = makeHandler("ok");
+        const spy = vi.fn();
+        const entries = [
+            makeEntry("tools/call", async (_req, _extra, next) => {
+                spy("tools/call");
+                return next();
+            }),
+        ];
+        // Matching
+        const chain1 = buildMiddlewareChain("tools/call", false, original, entries);
+        await chain1({ method: "tools/call", params: {} }, fakeExtra);
+        expect(spy).toHaveBeenCalledTimes(1);
+        // Non-matching — returns original handler directly
+        const chain2 = buildMiddlewareChain("tools/list", false, original, entries);
+        expect(chain2).toBe(original);
+    });
+    it("executes middleware in registration order (onion model)", async () => {
+        const calls = [];
+        const original = makeHandler("result");
+        const chain = buildMiddlewareChain("tools/call", false, original, [
+            makeEntry(null, async (_req, _extra, next) => {
+                calls.push("A:before");
+                const result = await next();
+                calls.push("A:after");
+                return result;
+            }),
+            makeEntry(null, async (_req, _extra, next) => {
+                calls.push("B:before");
+                const result = await next();
+                calls.push("B:after");
+                return result;
+            }),
+        ]);
+        await chain({ method: "tools/call", params: {} }, fakeExtra);
+        expect(calls).toEqual(["A:before", "B:before", "B:after", "A:after"]);
+    });
+    it("short-circuit (no next() call) skips handler", async () => {
+        const original = makeHandler("original");
+        const chain = buildMiddlewareChain("tools/call", false, original, [
+            makeEntry(null, async () => "short-circuited"),
+        ]);
+        const result = await chain({ method: "tools/call", params: {} }, fakeExtra);
+        expect(result).toBe("short-circuited");
+        expect(original).not.toHaveBeenCalled();
+    });
+    it("middleware can modify result post-next()", async () => {
+        const original = makeHandler({ value: 1 });
+        const chain = buildMiddlewareChain("tools/call", false, original, [
+            makeEntry(null, async (_req, _extra, next) => {
+                const result = (await next());
+                return { value: result.value + 10 };
+            }),
+        ]);
+        const result = await chain({ method: "tools/call", params: {} }, fakeExtra);
+        expect(result).toEqual({ value: 11 });
+    });
+    it("throws on double next() call", async () => {
+        const original = makeHandler("ok");
+        const chain = buildMiddlewareChain("tools/call", false, original, [
+            makeEntry(null, async (_req, _extra, next) => {
+                await next();
+                return next(); // double call
+            }),
+        ]);
+        await expect(chain({ method: "tools/call", params: {} }, fakeExtra)).rejects.toThrow("next() called multiple times");
+    });
+    it("propagates errors from handler and middleware", async () => {
+        // Error from original handler bubbles through middleware
+        const failingHandler = vi.fn(async () => {
+            throw new Error("handler boom");
+        });
+        const chain1 = buildMiddlewareChain("tools/call", false, failingHandler, [
+            makeEntry(null, async (_req, _extra, next) => next()),
+        ]);
+        await expect(chain1({ method: "tools/call", params: {} }, fakeExtra)).rejects.toThrow("handler boom");
+        // Error thrown inside middleware propagates
+        const chain2 = buildMiddlewareChain("tools/call", false, makeHandler("ok"), [
+            makeEntry(null, async () => {
+                throw new Error("middleware boom");
+            }),
+        ]);
+        await expect(chain2({ method: "tools/call", params: {} }, fakeExtra)).rejects.toThrow("middleware boom");
+    });
+    it("passes extra as undefined for notifications (isNotification=true)", async () => {
+        const original = makeHandler(undefined);
+        let capturedExtra = {};
+        const chain = buildMiddlewareChain("notifications/initialized", true, original, [
+            makeEntry(null, async (_req, extra, next) => {
+                capturedExtra = extra;
+                return next();
+            }),
+        ]);
+        await chain({ method: "notifications/initialized" });
+        expect(capturedExtra).toBeUndefined();
+    });
+    it("defaults params to empty object when rawRequest has no params", async () => {
+        const original = makeHandler("ok");
+        let capturedParams;
+        const chain = buildMiddlewareChain("tools/call", false, original, [
+            makeEntry(null, async (request, _extra, next) => {
+                capturedParams = request.params;
+                return next();
+            }),
+        ]);
+        await chain({ method: "tools/call" }, fakeExtra);
+        expect(capturedParams).toEqual({});
+    });
+    it("propagates in-place param mutation to original handler", async () => {
+        let handlerReceivedName = "";
+        const original = vi.fn(async (rawReq) => {
+            handlerReceivedName = rawReq.params.name;
+            return "ok";
+        });
+        const chain = buildMiddlewareChain("tools/call", false, original, [
+            makeEntry(null, async (request, _extra, next) => {
+                request.params.name = "mutated";
+                return next();
+            }),
+        ]);
+        await chain({ params: { name: "original" } }, fakeExtra);
+        expect(handlerReceivedName).toBe("mutated");
+    });
+    it("propagates full param replacement to original handler", async () => {
+        let handlerReceivedParams = {};
+        const original = vi.fn(async (rawReq) => {
+            handlerReceivedParams = rawReq.params;
+            return "ok";
+        });
+        const chain = buildMiddlewareChain("tools/call", false, original, [
+            makeEntry(null, async (request, _extra, next) => {
+                request.params = { replaced: true };
+                return next();
+            }),
+        ]);
+        await chain({ params: { original: true } }, fakeExtra);
+        expect(handlerReceivedParams).toEqual({ replaced: true });
+    });
+});
+// ---------------------------------------------------------------------------
+// McpServer.mcpMiddleware() integration tests
+// ---------------------------------------------------------------------------
+describe("McpServer.mcpMiddleware()", () => {
+    function createClient() {
+        return new Client({ name: "test-client", version: "1.0.0" });
+    }
+    it("returns this for chaining", () => {
+        new Skybridge({
+            name: "test",
+            version: "1.0.0",
+            handler: (server) => {
+                const result = server.mcpMiddleware(async (_req, _extra, next) => next());
+                expect(result).toBe(server);
+                return server;
+            },
+        });
+    });
+    it("intercepts tools/call and exposes request params", async () => {
+        let capturedMethod = "";
+        let capturedParams = {};
+        const app = new Skybridge({
+            name: "test",
+            version: "1.0.0",
+            handler: (server) => {
+                server.registerTool({
+                    name: "greet",
+                    description: "greet",
+                    inputSchema: { name: z.string() },
+                }, (args) => ({
+                    content: [{ type: "text", text: `hi ${args.name}` }],
+                }));
+                server.mcpMiddleware("tools/call", async (request, _extra, next) => {
+                    capturedMethod = request.method;
+                    capturedParams = request.params;
+                    return next();
+                });
+                return server;
+            },
+        });
+        const client = createClient();
+        const [clientTransport, serverTransport] = InMemoryTransport.createLinkedPair();
+        const instance = await app.createServerInstance();
+        await instance.connect(serverTransport);
+        await client.connect(clientTransport);
+        const result = await client.callTool({
+            name: "greet",
+            arguments: { name: "World" },
+        });
+        expect(capturedMethod).toBe("tools/call");
+        expect(capturedParams).toMatchObject({
+            name: "greet",
+            arguments: { name: "World" },
+        });
+        expect(result.content).toEqual([{ type: "text", text: "hi World" }]);
+        await client.close();
+        await instance.close();
+    });
+    it("array filter works", async () => {
+        const matchedMethods = [];
+        const app = new Skybridge({
+            name: "test",
+            version: "1.0.0",
+            handler: (server) => {
+                server.registerTool({ name: "t1", description: "t1" }, () => ({
+                    content: [{ type: "text", text: "ok" }],
+                }));
+                server.mcpMiddleware(["tools/call", "tools/list"], async (request, _extra, next) => {
+                    matchedMethods.push(request.method);
+                    return next();
+                });
+                return server;
+            },
+        });
+        const client = createClient();
+        const [clientTransport, serverTransport] = InMemoryTransport.createLinkedPair();
+        const instance = await app.createServerInstance();
+        await instance.connect(serverTransport);
+        await client.connect(clientTransport);
+        await client.listTools();
+        await client.callTool({ name: "t1" });
+        expect(matchedMethods).toEqual(["tools/list", "tools/call"]);
+        await client.close();
+        await instance.close();
+    });
+    it("throws when filter provided without handler", async () => {
+        const app = new Skybridge({
+            name: "test",
+            version: "1.0.0",
+            handler: (server) => 
+            // @ts-expect-error intentionally passing filter without handler
+            server.mcpMiddleware("tools/call"),
+        });
+        await expect(app.createServerInstance()).rejects.toThrow("mcpMiddleware requires a handler function");
+    });
+    it("catch-all middleware + filtered middleware stack correctly", async () => {
+        const calls = [];
+        const app = new Skybridge({
+            name: "test",
+            version: "1.0.0",
+            handler: (server) => {
+                server.registerTool({ name: "t1", description: "t1" }, () => ({
+                    content: [{ type: "text", text: "ok" }],
+                }));
+                server
+                    .mcpMiddleware(async (request, _extra, next) => {
+                    calls.push(`global:${request.method}`);
+                    return next();
+                })
+                    .mcpMiddleware("tools/call", async (_req, _extra, next) => {
+                    calls.push("tools-only");
+                    return next();
+                });
+                return server;
+            },
+        });
+        const client = createClient();
+        const [clientTransport, serverTransport] = InMemoryTransport.createLinkedPair();
+        const instance = await app.createServerInstance();
+        await instance.connect(serverTransport);
+        await client.connect(clientTransport);
+        await client.listTools();
+        await client.callTool({ name: "t1" });
+        // Catch-all also intercepts initialize + notifications/initialized from handshake.
+        // tools/list: only global middleware runs
+        // tools/call: global + tools-only both run
+        expect(calls).toContain("global:tools/list");
+        expect(calls).toContain("global:tools/call");
+        expect(calls).toContain("tools-only");
+        // "tools-only" must come right after "global:tools/call"
+        const toolsCallIdx = calls.indexOf("global:tools/call");
+        expect(calls[toolsCallIdx + 1]).toBe("tools-only");
+        await client.close();
+        await instance.close();
+    });
+    it("notification middleware receives extra as undefined", async () => {
+        let capturedExtra = "sentinel";
+        const app = new Skybridge({
+            name: "test",
+            version: "1.0.0",
+            handler: (server) => {
+                server.registerTool({ name: "t1", description: "t1" }, () => ({
+                    content: [{ type: "text", text: "ok" }],
+                }));
+                server.mcpMiddleware("notification", async (_request, extra, next) => {
+                    capturedExtra = extra;
+                    return next();
+                });
+                return server;
+            },
+        });
+        const client = createClient();
+        const [clientTransport, serverTransport] = InMemoryTransport.createLinkedPair();
+        const instance = await app.createServerInstance();
+        await instance.connect(serverTransport);
+        await client.connect(clientTransport);
+        // The client sends notifications/initialized automatically on connect.
+        await client.listTools();
+        expect(capturedExtra).toBeUndefined();
+        await client.close();
+        await instance.close();
+    });
+    it("wildcard filter intercepts matching methods only", async () => {
+        const matchedMethods = [];
+        const app = new Skybridge({
+            name: "test",
+            version: "1.0.0",
+            handler: (server) => {
+                server.registerTool({ name: "t1", description: "t1" }, () => ({
+                    content: [{ type: "text", text: "ok" }],
+                }));
+                server.mcpMiddleware("tools/*", async (request, _extra, next) => {
+                    matchedMethods.push(request.method);
+                    return next();
+                });
+                return server;
+            },
+        });
+        const client = createClient();
+        const [clientTransport, serverTransport] = InMemoryTransport.createLinkedPair();
+        const instance = await app.createServerInstance();
+        await instance.connect(serverTransport);
+        await client.connect(clientTransport);
+        await client.listTools();
+        await client.callTool({ name: "t1" });
+        expect(matchedMethods).toContain("tools/list");
+        expect(matchedMethods).toContain("tools/call");
+        // Should not match initialize or notifications
+        expect(matchedMethods).not.toContain("initialize");
+        expect(matchedMethods).not.toContain("notifications/initialized");
+        await client.close();
+        await instance.close();
+    });
+    it("middleware can modify tool result via Skybridge integration", async () => {
+        const app = new Skybridge({
+            name: "test",
+            version: "1.0.0",
+            handler: (server) => {
+                server.registerTool({
+                    name: "greet",
+                    description: "greet",
+                    inputSchema: { name: z.string() },
+                }, (args) => ({
+                    content: [{ type: "text", text: `hi ${args.name}` }],
+                }));
+                server.mcpMiddleware("tools/call", async (_req, _extra, next) => {
+                    const result = (await next());
+                    return {
+                        ...result,
+                        content: [
+                            ...result.content,
+                            { type: "text", text: " (modified)" },
+                        ],
+                    };
+                });
+                return server;
+            },
+        });
+        const client = createClient();
+        const [clientTransport, serverTransport] = InMemoryTransport.createLinkedPair();
+        const instance = await app.createServerInstance();
+        await instance.connect(serverTransport);
+        await client.connect(clientTransport);
+        const result = await client.callTool({
+            name: "greet",
+            arguments: { name: "World" },
+        });
+        expect(result.content).toEqual([
+            { type: "text", text: "hi World" },
+            { type: "text", text: " (modified)" },
+        ]);
+        await client.close();
+        await instance.close();
+    });
+    it("middleware can short-circuit via Skybridge integration", async () => {
+        const handlerCalled = vi.fn();
+        const app = new Skybridge({
+            name: "test",
+            version: "1.0.0",
+            handler: (server) => {
+                server.registerTool({ name: "t1", description: "t1" }, () => {
+                    handlerCalled();
+                    return {
+                        content: [{ type: "text", text: "original" }],
+                    };
+                });
+                server.mcpMiddleware("tools/call", async () => ({
+                    content: [{ type: "text", text: "short-circuited" }],
+                }));
+                return server;
+            },
+        });
+        const client = createClient();
+        const [clientTransport, serverTransport] = InMemoryTransport.createLinkedPair();
+        const instance = await app.createServerInstance();
+        await instance.connect(serverTransport);
+        await client.connect(clientTransport);
+        const result = await client.callTool({ name: "t1" });
+        expect(result.content).toEqual([{ type: "text", text: "short-circuited" }]);
+        expect(handlerCalled).not.toHaveBeenCalled();
+        await client.close();
+        await instance.close();
+    });
+    it("exposes a thrown tool error to middleware via getToolError", async () => {
+        const schemaError = new Error("boom with schema");
+        const schemalessError = new Error("boom without schema");
+        let captured;
+        const app = new Skybridge({
+            name: "test",
+            version: "1.0.0",
+            handler: (server) => {
+                server.registerTool({
+                    name: "withSchema",
+                    description: "withSchema",
+                    inputSchema: { name: z.string() },
+                }, () => {
+                    throw schemaError;
+                });
+                server.registerTool({ name: "withoutSchema", description: "withoutSchema" }, () => {
+                    throw schemalessError;
+                });
+                server.mcpMiddleware("tools/call", async (_request, extra, next) => {
+                    const result = await next();
+                    captured = getToolError(extra);
+                    return result;
+                });
+                return server;
+            },
+        });
+        const client = createClient();
+        const [clientTransport, serverTransport] = InMemoryTransport.createLinkedPair();
+        const instance = await app.createServerInstance();
+        await instance.connect(serverTransport);
+        await client.connect(clientTransport);
+        const withSchema = await client.callTool({
+            name: "withSchema",
+            arguments: { name: "World" },
+        });
+        expect(withSchema.isError).toBe(true);
+        expect(captured).toBe(schemaError);
+        const withoutSchema = await client.callTool({ name: "withoutSchema" });
+        expect(withoutSchema.isError).toBe(true);
+        expect(captured).toBe(schemalessError);
+        await client.close();
+        await instance.close();
+    });
+    it("middleware can mutate tool call params via Skybridge integration", async () => {
+        let receivedName = "";
+        const app = new Skybridge({
+            name: "test",
+            version: "1.0.0",
+            handler: (server) => {
+                server.registerTool({
+                    name: "greet",
+                    description: "greet",
+                    inputSchema: { name: z.string() },
+                }, (args) => {
+                    receivedName = args.name;
+                    return {
+                        content: [{ type: "text", text: `hi ${args.name}` }],
+                    };
+                });
+                server.mcpMiddleware("tools/call", async (request, _extra, next) => {
+                    request.params.arguments = { name: "Overridden" };
+                    return next();
+                });
+                return server;
+            },
+        });
+        const client = createClient();
+        const [clientTransport, serverTransport] = InMemoryTransport.createLinkedPair();
+        const instance = await app.createServerInstance();
+        await instance.connect(serverTransport);
+        await client.connect(clientTransport);
+        await client.callTool({
+            name: "greet",
+            arguments: { name: "Original" },
+        });
+        expect(receivedName).toBe("Overridden");
+        await client.close();
+        await instance.close();
+    });
+    it("category 'request' filter matches requests but not notifications", async () => {
+        const matchedMethods = [];
+        const app = new Skybridge({
+            name: "test",
+            version: "1.0.0",
+            handler: (server) => {
+                server.registerTool({ name: "t1", description: "t1" }, () => ({
+                    content: [{ type: "text", text: "ok" }],
+                }));
+                server.mcpMiddleware("request", async (request, _extra, next) => {
+                    matchedMethods.push(request.method);
+                    return next();
+                });
+                return server;
+            },
+        });
+        const client = createClient();
+        const [clientTransport, serverTransport] = InMemoryTransport.createLinkedPair();
+        const instance = await app.createServerInstance();
+        await instance.connect(serverTransport);
+        await client.connect(clientTransport);
+        await client.listTools();
+        await client.callTool({ name: "t1" });
+        expect(matchedMethods).toContain("tools/list");
+        expect(matchedMethods).toContain("tools/call");
+        expect(matchedMethods).not.toContain("notifications/initialized");
+        await client.close();
+        await instance.close();
+    });
+});
+// ---------------------------------------------------------------------------
+// getHandlerMaps
+// ---------------------------------------------------------------------------
+describe("getHandlerMaps", () => {
+    it("throws for incompatible server objects", () => {
+        // Empty object
+        expect(() => getHandlerMaps({})).toThrow("Incompatible MCP SDK version");
+        // Only _requestHandlers (missing _notificationHandlers)
+        expect(() => getHandlerMaps({ _requestHandlers: new Map() })).toThrow("Incompatible MCP SDK version");
+        // Non-Map values
+        expect(() => getHandlerMaps({
+            _requestHandlers: {},
+            _notificationHandlers: {},
+        })).toThrow("Incompatible MCP SDK version");
+    });
+    it("returns handler maps from valid server", () => {
+        const reqMap = new Map();
+        const notifMap = new Map();
+        const fake = {
+            _requestHandlers: reqMap,
+            _notificationHandlers: notifMap,
+        };
+        const result = getHandlerMaps(fake);
+        expect(result.requestHandlers).toBe(reqMap);
+        expect(result.notificationHandlers).toBe(notifMap);
+    });
+});
+//# sourceMappingURL=middleware.test.js.map