Skip to content

Commit 4b07e9c

Browse files
cliffhallclaude
andauthored
fix: resolve the findings the root ESLint config reports
The type-aware root config reports 175 findings across the four TS servers and 4 in the root tooling; each is fixed rather than suppressed: explicit types for every any/Function in the tests (via SDK types and a small typed helper module in everything's __tests__), unused imports and variables removed, caught errors given a cause, empty catches explained, floating promises held or voided with a reason, and filesystem's tools now publish their named zod schemas' shapes instead of hand-copied duplicates (identical fields, so the input schemas are unchanged). Refs #4864 Co-Authored-By: Claude Opus 5.5 <[email protected]> Signed-off-by: cliffhall <[email protected]>
1 parent a216dd9 commit 4b07e9c

24 files changed

Lines changed: 512 additions & 388 deletions
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
/**
2+
* Shared typing helpers for the everything-server unit tests.
3+
*
4+
* The tests capture the handlers a register* function passes to a mocked
5+
* McpServer and invoke them directly. These types describe exactly what the
6+
* tests call them with — a plain argument object and a partial request
7+
* `extra` — so the captured handlers are typed without `any` or `Function`.
8+
* `contentOfType` narrows a content block to one member of the SDK's
9+
* `ContentBlock` union, failing loudly when the block is some other kind.
10+
*/
11+
import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
12+
import type {
13+
CallToolResult,
14+
ContentBlock,
15+
GetPromptResult,
16+
ReadResourceResult,
17+
ServerNotification,
18+
ServerRequest,
19+
} from "@modelcontextprotocol/sdk/types.js";
20+
21+
/** The request context a tool/prompt/resource handler receives. */
22+
export type HandlerExtra = RequestHandlerExtra<
23+
ServerRequest,
24+
ServerNotification
25+
>;
26+
27+
/** A captured tool handler, as the tests invoke it. */
28+
export type ToolHandler = (
29+
args: Record<string, unknown>,
30+
extra?: Partial<HandlerExtra>,
31+
) => Promise<CallToolResult>;
32+
33+
/** A captured prompt handler, as the tests invoke it (the prompts are sync). */
34+
export type PromptHandler = (args?: Record<string, string>) => GetPromptResult;
35+
36+
/** A captured resource read handler, as the tests invoke it. */
37+
export type ResourceHandler = (
38+
uri: URL,
39+
extra?: Partial<HandlerExtra>,
40+
) => Promise<ReadResourceResult>;
41+
42+
/**
43+
* Narrow a content block to the member of the `ContentBlock` union whose
44+
* `type` is `type`, throwing if the block is missing or of another kind.
45+
*/
46+
export function contentOfType<T extends ContentBlock["type"]>(
47+
block: ContentBlock | undefined,
48+
type: T,
49+
): Extract<ContentBlock, { type: T }> {
50+
if (block?.type !== type) {
51+
throw new Error(`expected ${type} content, got ${block?.type}`);
52+
}
53+
return block as Extract<ContentBlock, { type: T }>;
54+
}
55+
56+
/** The text of a content block that must be a text block. */
57+
export function textOf(block: ContentBlock | undefined): string {
58+
return contentOfType(block, "text").text;
59+
}

‎src/everything/__tests__/prompts.test.ts‎

Lines changed: 31 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,22 @@ import { registerSimplePrompt } from "../prompts/simple.js";
44
import { registerArgumentsPrompt } from "../prompts/args.js";
55
import { registerPromptWithCompletions } from "../prompts/completions.js";
66
import { registerEmbeddedResourcePrompt } from "../prompts/resource.js";
7+
import { contentOfType, textOf, type PromptHandler } from "./helpers.js";
78

89
// Helper to capture registered prompt handlers
910
function createMockServer() {
10-
const handlers: Map<string, Function> = new Map();
11-
const configs: Map<string, any> = new Map();
11+
const handlers: Map<string, PromptHandler> = new Map();
12+
const configs: Map<string, unknown> = new Map();
1213

1314
const mockServer = {
14-
registerPrompt: vi.fn((name: string, config: any, handler: Function) => {
15-
handlers.set(name, handler);
16-
configs.set(name, config);
17-
}),
15+
registerPrompt: vi.fn(
16+
(name: string, config: unknown, handler: PromptHandler) => {
17+
handlers.set(name, handler);
18+
configs.set(name, config);
19+
},
20+
),
21+
// Partial mock: the prompt registrars only call registerPrompt, and
22+
// McpServer is a class whose private members no object literal can satisfy.
1823
} as unknown as McpServer;
1924

2025
return { mockServer, handlers, configs };
@@ -51,7 +56,7 @@ describe("Prompts", () => {
5156
const handler = handlers.get("args-prompt")!;
5257
const result = handler({ city: "San Francisco" });
5358

54-
expect(result.messages[0].content.text).toBe(
59+
expect(textOf(result.messages[0].content)).toBe(
5560
"What's weather in San Francisco?",
5661
);
5762
});
@@ -63,7 +68,7 @@ describe("Prompts", () => {
6368
const handler = handlers.get("args-prompt")!;
6469
const result = handler({ city: "San Francisco", state: "California" });
6570

66-
expect(result.messages[0].content.text).toBe(
71+
expect(textOf(result.messages[0].content)).toBe(
6772
"What's weather in San Francisco, California?",
6873
);
6974
});
@@ -75,10 +80,10 @@ describe("Prompts", () => {
7580
const handler = handlers.get("args-prompt")!;
7681
const result = handler({ city: "New York" });
7782

78-
expect(result.messages[0].content.text).toBe(
83+
expect(textOf(result.messages[0].content)).toBe(
7984
"What's weather in New York?",
8085
);
81-
expect(result.messages[0].content.text).not.toContain(",");
86+
expect(textOf(result.messages[0].content)).not.toContain(",");
8287
expect(result.messages[0].role).toBe("user");
8388
expect(result.messages[0].content.type).toBe("text");
8489
});
@@ -92,7 +97,7 @@ describe("Prompts", () => {
9297
const handler = handlers.get("completable-prompt")!;
9398
const result = handler({ department: "Engineering", name: "Alice" });
9499

95-
expect(result.messages[0].content.text).toBe(
100+
expect(textOf(result.messages[0].content)).toBe(
96101
"Please promote Alice to the head of the Engineering team.",
97102
);
98103
});
@@ -104,16 +109,18 @@ describe("Prompts", () => {
104109
const handler = handlers.get("completable-prompt")!;
105110

106111
const salesResult = handler({ department: "Sales", name: "David" });
107-
expect(salesResult.messages[0].content.text).toContain("Sales");
108-
expect(salesResult.messages[0].content.text).toContain("David");
112+
expect(textOf(salesResult.messages[0].content)).toContain("Sales");
113+
expect(textOf(salesResult.messages[0].content)).toContain("David");
109114
expect(salesResult.messages[0].role).toBe("user");
110115

111116
const marketingResult = handler({
112117
department: "Marketing",
113118
name: "Grace",
114119
});
115-
expect(marketingResult.messages[0].content.text).toContain("Marketing");
116-
expect(marketingResult.messages[0].content.text).toContain("Grace");
120+
expect(textOf(marketingResult.messages[0].content)).toContain(
121+
"Marketing",
122+
);
123+
expect(textOf(marketingResult.messages[0].content)).toContain("Grace");
117124
});
118125
});
119126

@@ -126,10 +133,12 @@ describe("Prompts", () => {
126133
const result = handler({ resourceType: "Text", resourceId: "1" });
127134

128135
expect(result.messages).toHaveLength(2);
129-
expect(result.messages[0].content.text).toContain("Text");
130-
expect(result.messages[0].content.text).toContain("1");
136+
expect(textOf(result.messages[0].content)).toContain("Text");
137+
expect(textOf(result.messages[0].content)).toContain("1");
131138
expect(result.messages[1].content.type).toBe("resource");
132-
expect(result.messages[1].content.resource.uri).toContain("text/1");
139+
expect(
140+
contentOfType(result.messages[1].content, "resource").resource.uri,
141+
).toContain("text/1");
133142
});
134143

135144
it("should return blob resource reference", () => {
@@ -139,8 +148,10 @@ describe("Prompts", () => {
139148
const handler = handlers.get("resource-prompt")!;
140149
const result = handler({ resourceType: "Blob", resourceId: "5" });
141150

142-
expect(result.messages[0].content.text).toContain("Blob");
143-
expect(result.messages[1].content.resource.uri).toContain("blob/5");
151+
expect(textOf(result.messages[0].content)).toContain("Blob");
152+
expect(
153+
contentOfType(result.messages[1].content, "resource").resource.uri,
154+
).toContain("blob/5");
144155
});
145156

146157
it("should reject invalid resource type", () => {

‎src/everything/__tests__/registrations.test.ts‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ describe("Registration Index Files", () => {
2828
expect(mockServer.registerTool).toHaveBeenCalledTimes(12);
2929

3030
// Verify specific tools are registered
31-
const registeredTools = (mockServer.registerTool as any).mock.calls.map(
32-
(call: any[]) => call[0],
33-
);
31+
const registeredTools = vi
32+
.mocked(mockServer.registerTool)
33+
.mock.calls.map((call) => call[0]);
3434
expect(registeredTools).toContain("echo");
3535
expect(registeredTools).toContain("get-sum");
3636
expect(registeredTools).toContain("get-env");
@@ -72,9 +72,9 @@ describe("Registration Index Files", () => {
7272
// so they are not included in this registerTool count.
7373
expect(mockServerWithCapabilities.registerTool).toHaveBeenCalledTimes(4);
7474

75-
const registeredTools = (
76-
mockServerWithCapabilities.registerTool as any
77-
).mock.calls.map((call: any[]) => call[0]);
75+
const registeredTools = vi
76+
.mocked(mockServerWithCapabilities.registerTool)
77+
.mock.calls.map((call) => call[0]);
7878
expect(registeredTools).toContain("get-roots-list");
7979
expect(registeredTools).toContain("trigger-elicitation-request");
8080
expect(registeredTools).toContain("trigger-url-elicitation");
@@ -118,9 +118,9 @@ describe("Registration Index Files", () => {
118118
// Should register 4 prompts
119119
expect(mockServer.registerPrompt).toHaveBeenCalledTimes(4);
120120

121-
const registeredPrompts = (
122-
mockServer.registerPrompt as any
123-
).mock.calls.map((call: any[]) => call[0]);
121+
const registeredPrompts = vi
122+
.mocked(mockServer.registerPrompt)
123+
.mock.calls.map((call) => call[0]);
124124
expect(registeredPrompts).toContain("simple-prompt");
125125
expect(registeredPrompts).toContain("args-prompt");
126126
expect(registeredPrompts).toContain("completable-prompt");
@@ -137,9 +137,9 @@ describe("Registration Index Files", () => {
137137

138138
// Should register at least the 2 resource templates (text and blob) plus file resources
139139
expect(mockServer.registerResource).toHaveBeenCalled();
140-
const registeredResources = (
141-
mockServer.registerResource as any
142-
).mock.calls.map((call: any[]) => call[0]);
140+
const registeredResources = vi
141+
.mocked(mockServer.registerResource)
142+
.mock.calls.map((call) => call[0]);
143143
expect(registeredResources).toContain("Dynamic Text Resource");
144144
expect(registeredResources).toContain("Dynamic Blob Resource");
145145
});

‎src/everything/__tests__/resources.test.ts‎

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import {
2828
stopSimulatedResourceUpdates,
2929
removeSubscriber,
3030
} from "../resources/subscriptions.js";
31+
import type { ResourceHandler } from "./helpers.js";
3132

3233
describe("Resource Templates", () => {
3334
describe("Constants", () => {
@@ -116,32 +117,26 @@ describe("Resource Templates", () => {
116117
// The completer is a zod schema wrapped with completable
117118
expect(resourceTypeCompleter).toBeDefined();
118119
// It should have the zod parse method
119-
expect(typeof (resourceTypeCompleter as any).parse).toBe("function");
120+
expect(typeof resourceTypeCompleter.parse).toBe("function");
120121
});
121122

122123
it("should validate string resource types", () => {
123124
// Test that valid strings pass validation
124-
expect(() => (resourceTypeCompleter as any).parse("Text")).not.toThrow();
125-
expect(() => (resourceTypeCompleter as any).parse("Blob")).not.toThrow();
125+
expect(() => resourceTypeCompleter.parse("Text")).not.toThrow();
126+
expect(() => resourceTypeCompleter.parse("Blob")).not.toThrow();
126127
});
127128
});
128129

129130
describe("resourceIdForPromptCompleter", () => {
130131
it("should be defined as a completable schema", () => {
131132
expect(resourceIdForPromptCompleter).toBeDefined();
132-
expect(typeof (resourceIdForPromptCompleter as any).parse).toBe(
133-
"function",
134-
);
133+
expect(typeof resourceIdForPromptCompleter.parse).toBe("function");
135134
});
136135

137136
it("should validate string IDs", () => {
138137
// Test that valid strings pass validation
139-
expect(() =>
140-
(resourceIdForPromptCompleter as any).parse("1"),
141-
).not.toThrow();
142-
expect(() =>
143-
(resourceIdForPromptCompleter as any).parse("100"),
144-
).not.toThrow();
138+
expect(() => resourceIdForPromptCompleter.parse("1")).not.toThrow();
139+
expect(() => resourceIdForPromptCompleter.parse("100")).not.toThrow();
145140
});
146141
});
147142

@@ -162,15 +157,15 @@ describe("Resource Templates", () => {
162157

163158
describe("registerResourceTemplates", () => {
164159
it("should register text and blob resource templates", () => {
165-
const registeredResources: any[] = [];
166-
167160
const mockServer = {
168-
registerResource: vi.fn((...args) => {
169-
registeredResources.push(args);
170-
}),
161+
registerResource: vi.fn(),
162+
// Partial mock: registerResourceTemplates only calls registerResource,
163+
// and McpServer's private members rule out a structural literal.
171164
} as unknown as McpServer;
172165

173166
registerResourceTemplates(mockServer);
167+
const registeredResources = vi.mocked(mockServer.registerResource).mock
168+
.calls;
174169

175170
expect(mockServer.registerResource).toHaveBeenCalledTimes(2);
176171

@@ -179,7 +174,7 @@ describe("Resource Templates", () => {
179174
r[0].includes("Text"),
180175
);
181176
expect(textRegistration).toBeDefined();
182-
expect(textRegistration[1]).toBeInstanceOf(ResourceTemplate);
177+
expect(textRegistration?.[1]).toBeInstanceOf(ResourceTemplate);
183178

184179
// Check blob resource registration
185180
const blobRegistration = registeredResources.find((r) =>
@@ -210,11 +205,8 @@ describe("Session Resources", () => {
210205

211206
describe("registerSessionResource", () => {
212207
it("should register text resource and return resource link", () => {
213-
const registrations: any[] = [];
214208
const mockServer = {
215-
registerResource: vi.fn((...args) => {
216-
registrations.push(args);
217-
}),
209+
registerResource: vi.fn(),
218210
} as unknown as McpServer;
219211

220212
const resource = {
@@ -270,11 +262,18 @@ describe("Session Resources", () => {
270262
});
271263

272264
it("should return resource handler that provides correct content", async () => {
273-
let capturedHandler: Function | null = null;
265+
let capturedHandler: ResourceHandler | null = null;
274266
const mockServer = {
275-
registerResource: vi.fn((_name, _uri, _config, handler) => {
276-
capturedHandler = handler;
277-
}),
267+
registerResource: vi.fn(
268+
(
269+
_name: string,
270+
_uri: string,
271+
_config: unknown,
272+
handler: ResourceHandler,
273+
) => {
274+
capturedHandler = handler;
275+
},
276+
),
278277
} as unknown as McpServer;
279278

280279
const resource = {
@@ -294,8 +293,10 @@ describe("Session Resources", () => {
294293

295294
const handlerResult = await capturedHandler!(new URL(resource.uri));
296295
expect(handlerResult.contents).toHaveLength(1);
297-
expect(handlerResult.contents[0].text).toBe("Test content here");
298-
expect(handlerResult.contents[0].mimeType).toBe("text/plain");
296+
expect(handlerResult.contents[0]).toMatchObject({
297+
text: "Test content here",
298+
mimeType: "text/plain",
299+
});
299300
});
300301
});
301302
});

‎src/everything/__tests__/server.test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { describe, it, expect, vi } from "vitest";
1+
import { describe, it, expect } from "vitest";
22
import { createServer } from "../server/index.js";
33

44
describe("Server Factory", () => {

0 commit comments

Comments
 (0)