Skip to content

fix: stream mcp wait#319

Merged
akitaSummer merged 2 commits intoeggjs:masterfrom
akitaSummer:fix/stream-wait
May 13, 2025
Merged

fix: stream mcp wait#319
akitaSummer merged 2 commits intoeggjs:masterfrom
akitaSummer:fix/stream-wait

Conversation

@akitaSummer
Copy link
Contributor

@akitaSummer akitaSummer commented May 13, 2025

Checklist
  • npm test passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)
Description of change

Summary by CodeRabbit

  • Bug Fixes
    • Improved handling of HTTP response streams to ensure requests are fully processed before completion.
  • New Features
    • Added comprehensive integration tests for multi-client protocol (MCP) cluster interactions over SSE and streamable HTTP transports.

@coderabbitai
Copy link

coderabbitai bot commented May 13, 2025

Walkthrough

The change refactors multiple instances in MCPControllerRegister.ts and plugin/mcp-proxy/index.ts by replacing manual Promise constructions that awaited the HTTP response 'close' event with direct calls to the awaitEvent utility. Additionally, it adds the await-event dependency in relevant packages, simplifies test setup in mcp.test.ts, and introduces a new comprehensive integration test suite mcpCluster.test.ts covering MCP client-server interactions over SSE and streamable HTTP transports.

Changes

File(s) Change Summary
plugin/controller/lib/impl/mcp/MCPControllerRegister.ts Replaced manual Promise constructions awaiting ctx.res.once('close', ...) with await awaitEvent(ctx.res, 'close') in multiple stream server init methods.
plugin/mcp-proxy/index.ts Replaced manual Promise awaiting the response 'close' event with direct awaitEvent usage in the onStreamSessionInitialized proxy handler.
plugin/controller/package.json, plugin/mcp-proxy/package.json Added "await-event": "^2.1.0" dependency to both package.json files.
plugin/controller/test/mcp/mcp.test.ts Simplified test app initialization by replacing mm.cluster with mm.app and removing worker and environment customizations.
plugin/controller/test/mcp/mcpCluster.test.ts Added new integration test suite for MCP cluster app verifying SSE and streamable HTTP client transports, covering tool invocation, notifications, resource and prompt handling.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant MCPControllerRegister
    participant Transport
    participant HTTPResponse

    Client->>MCPControllerRegister: Send HTTP request
    MCPControllerRegister->>Transport: handleRequest(req, res)
    Transport-->>HTTPResponse: Process and send response
    HTTPResponse-->>MCPControllerRegister: 'close' event emitted (awaited via awaitEvent)
    MCPControllerRegister-->>Client: Complete handling after response closes
Loading
sequenceDiagram
    participant Client
    participant MCPProxy
    participant Transport
    participant HTTPResponse

    Client->>MCPProxy: Send stream request
    MCPProxy->>Transport: handleRequest(req, res)
    Transport-->>HTTPResponse: Process and send response
    HTTPResponse-->>MCPProxy: 'close' event emitted (awaited via awaitEvent)
    MCPProxy-->>Client: Complete handling after response closes
Loading

Possibly related PRs

  • fix: mcp context proto #318: Introduces a similar pattern of awaiting the HTTP response 'close' event in MCPControllerRegister with manual Promise constructions, directly related to event handling in the same file.

Suggested reviewers

  • killagu

Poem

🐇
Await the close, no more delay,
Promises vanish, smooth the way.
Streams now end with tidy grace,
Async hops in every place.
Tools and tests in clusters run,
Rabbit cheers: the job is done! 🥕

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

plugin/controller/lib/impl/mcp/MCPControllerRegister.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-eggache".

(The package "eslint-plugin-eggache" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-eggache@latest --save-dev

The plugin "eslint-plugin-eggache" was referenced from the config file in ".eslintrc » eslint-config-egg/typescript » ./index.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

plugin/controller/test/mcp/mcp.test.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-eggache".

(The package "eslint-plugin-eggache" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-eggache@latest --save-dev

The plugin "eslint-plugin-eggache" was referenced from the config file in ".eslintrc » eslint-config-egg/typescript » ./index.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

plugin/mcp-proxy/index.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-eggache".

(The package "eslint-plugin-eggache" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-eggache@latest --save-dev

The plugin "eslint-plugin-eggache" was referenced from the config file in ".eslintrc » eslint-config-egg/typescript » ./index.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

  • 1 others

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🔭 Outside diff range comments (1)
plugin/controller/test/mcp/mcp.test.ts (1)

60-66: 🛠️ Refactor suggestion

⚠️ Potential issue

Remove duplicate after hooks to comply with test-runner rules

Two separate after hooks are registered:

after(async () => {  });   // lines 62-64

after(() => {  });         // lines 82-84

Most runners (mocha, jest) treat multiple identical lifecycle hooks as a code-smell and, as Biome points out, will warn or fail with noDuplicateTestHooks.
Unless you explicitly need both (e.g. different clean-up scopes), consolidate them:

-after(async () => {
-  await app.close();
-});
-
-
-
-after(() => {
-  return app.close();
-});
+after(async () => {
+  await app.close();
+});

(The single await app.close() is sufficient.)

Also applies to: 80-85

🧹 Nitpick comments (3)
plugin/controller/test/mcp/mcp.test.ts (1)

66-70: Restore mocked environment between tests

afterEach currently contains only commented-out code:

// mm.restore();

If mocks aren’t restored, state can leak between specs and cause flakiness.
Uncomment (or delete if unused):

-// mm.restore();
+mm.restore();
plugin/controller/test/mcp/mcpCluster.test.ts (2)

130-141: 5-second setTimeout pauses make the suite slow – consider event-driven awaits

Each protocol test sleeps for 5 s to collect notifications. With three repetitions this adds 15 s+ to every test run.

If possible, replace the hard wait with a promise that resolves when the expected number of notifications arrives, e.g.:

await new Promise<void>(resolve => {
  const expected = 5;
  let seen = 0;
  client.setNotificationHandler(schema, () => {
    if (++seen === expected) resolve();
  });
});

This keeps tests deterministic and dramatically speeds up CI.

Also applies to: 224-232, 322-329


66-70: Restore mocks after each case

Same as in mcp.test.ts – the afterEach hook only contains a commented‐out mm.restore(). Uncomment to avoid state leakage.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b2c877a and 0edc4c9.

📒 Files selected for processing (6)
  • plugin/controller/lib/impl/mcp/MCPControllerRegister.ts (4 hunks)
  • plugin/controller/package.json (1 hunks)
  • plugin/controller/test/mcp/mcp.test.ts (1 hunks)
  • plugin/controller/test/mcp/mcpCluster.test.ts (1 hunks)
  • plugin/mcp-proxy/index.ts (2 hunks)
  • plugin/mcp-proxy/package.json (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • plugin/controller/package.json
  • plugin/mcp-proxy/package.json
🚧 Files skipped from review as they are similar to previous changes (1)
  • plugin/controller/lib/impl/mcp/MCPControllerRegister.ts
🧰 Additional context used
🪛 Biome (1.9.4)
plugin/controller/test/mcp/mcpCluster.test.ts

[error] 92-94: Disallow duplicate setup and teardown hooks.

Disallow after duplicacy inside the describe function.

(lint/suspicious/noDuplicateTestHooks)

⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: Runner-ubuntu (22)
  • GitHub Check: Runner-ubuntu (20)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (typescript)
  • GitHub Check: Runner-macos (16)
  • GitHub Check: Runner-ubuntu (18)
  • GitHub Check: Runner-macos (18)
  • GitHub Check: Runner-macos (20)
  • GitHub Check: Runner-ubuntu (16)
🔇 Additional comments (2)
plugin/controller/test/mcp/mcpCluster.test.ts (1)

75-88: Cluster bootstrap options: unnecessary NODE_OPTIONS override

NODE_OPTIONS: '--require ts-node/register tsconfig-paths/register' is only needed when spawning TypeScript directly. The fixture app is already compiled via egg-bin. Removing this env override can shorten start-up time and avoid duplicate registrations. Verify whether tests still pass and then drop the option if not required.

plugin/mcp-proxy/index.ts (1)

1-3: ESM/CommonJS inter-op: confirm await-event supports default import

You added

import awaitEvent from 'await-event';

await-event publishes its entry point as module.exports = function awaitEvent….
With Node ≥ 16 in ESM mode, default is undefined unless the package has "default" export mapping.

Safer import:

import { default as awaitEvent } from 'await-event'; // for CJS packages

or

const awaitEvent = (await import('await-event')).default;

Please verify at runtime; otherwise the new code path will throw TypeError: awaitEvent is not a function.

Copy link
Contributor

@killagu killagu left a comment

Choose a reason for hiding this comment

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

LGTM

@akitaSummer akitaSummer merged commit 47ef28b into eggjs:master May 13, 2025
13 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Nov 18, 2025
4 tasks
@coderabbitai coderabbitai bot mentioned this pull request Jan 27, 2026
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants