Skip to content

fix: add mcp clearInterval#332

Merged
akitaSummer merged 1 commit intoeggjs:masterfrom
akitaSummer:fix/mcp-intervalId
Jun 18, 2025
Merged

fix: add mcp clearInterval#332
akitaSummer merged 1 commit intoeggjs:masterfrom
akitaSummer:fix/mcp-intervalId

Conversation

@akitaSummer
Copy link
Copy Markdown
Contributor

@akitaSummer akitaSummer commented Jun 18, 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 cleanup of server-sent events (SSE) connections to prevent potential resource leaks when connections close.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 18, 2025

Walkthrough

The change updates the cleanup logic in the sseCtxStorageRun method's transport.onclose handler, ensuring that the interval timer associated with each SSE connection is cleared before removing the connection from the sseConnections map. This prevents potential resource leaks when SSE connections close.

Changes

File(s) Change Summary
plugin/controller/lib/impl/mcp/MCPControllerRegister.ts Modified SSE connection cleanup to clear interval timers before deleting connections from map.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant MCPControllerRegister
    participant SSETransport

    Client->>MCPControllerRegister: Establish SSE connection
    MCPControllerRegister->>SSETransport: Start keepalive interval
    Note right of MCPControllerRegister: Store intervalId in sseConnections

    SSETransport-->>MCPControllerRegister: onclose event
    MCPControllerRegister->>MCPControllerRegister: Retrieve connection by sessionId
    MCPControllerRegister->>MCPControllerRegister: Clear interval by intervalId
    MCPControllerRegister->>MCPControllerRegister: Delete connection from sseConnections
Loading

Possibly related PRs

  • fix: mcp mem leak #329: Extends cleanup logic by also clearing the interval timer before deleting the SSE connection, building on the same handler.
  • fix: mcp context proto #318: Modifies the SSE transport's onclose handler for request tracking and removal, sharing the focus on cleanup in sseCtxStorageRun.
  • fix: zod phantom dependency #322: Adds a static clean() method for shutdown cleanup in the same file/class, addressing related cleanup mechanisms.

Suggested reviewers

  • fengmk2

Poem

A timer ticks for every stream,
But now, when closed, we intervene—
No intervals left to stray or roam,
We clear them out before they’re gone.
Connections neat, our code pristine,
A tidy warren, safe and clean!
🐇✨

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.

✨ 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
Copy Markdown

@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: 0

🧹 Nitpick comments (1)
plugin/controller/lib/impl/mcp/MCPControllerRegister.ts (1)

386-390: Good catch – interval now cleared, but consider centralising cleanup logic

The added block correctly clears the heartbeat interval and removes the entry from sseConnections, preventing a potential timer leak.
However, very similar cleanup logic also lives inside the keep-alive setInterval callback (lines 352-359). Having two places that both call clearInterval/delete makes the code harder to reason about and increases the chance of them drifting apart.

A small helper such as private cleanupSSEConnection(id: string) would encapsulate the two clearInterval + delete operations and let both the interval callback and transport.onclose call the same routine.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 411c89c and 809e618.

📒 Files selected for processing (1)
  • plugin/controller/lib/impl/mcp/MCPControllerRegister.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: Runner-ubuntu (20)
  • GitHub Check: Runner-macos (16)
  • GitHub Check: Runner-ubuntu (22)
  • GitHub Check: Runner-ubuntu (18)
  • GitHub Check: Runner-macos (20)
  • GitHub Check: Runner-macos (18)
  • GitHub Check: Runner-ubuntu (16)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (typescript)

Copy link
Copy Markdown
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 b29d68b into eggjs:master Jun 18, 2025
13 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request Apr 21, 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