Skip to content

fix: zod phantom dependency#322

Merged
killagu merged 1 commit intoeggjs:masterfrom
akitaSummer:fix/zod-phantom-dependency
May 15, 2025
Merged

fix: zod phantom dependency#322
killagu merged 1 commit intoeggjs:masterfrom
akitaSummer:fix/zod-phantom-dependency

Conversation

@akitaSummer
Copy link
Contributor

@akitaSummer akitaSummer commented May 14, 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

  • Chores

    • Added the zod library as a new dependency across multiple packages to enhance validation capabilities.
  • New Features

    • Introduced a cleanup mechanism for MCP controller registration when the application is closing, improving resource management and stability.

@coderabbitai
Copy link

coderabbitai bot commented May 14, 2025

Walkthrough

The updates introduce the zod library as a new runtime dependency in three package manifests. Additionally, a static clean() method is added to the MCPControllerRegister class, and the application's shutdown logic is updated to invoke this cleanup method during the beforeClose lifecycle event.

Changes

File(s) Change Summary
core/controller-decorator/package.json,
plugin/controller/package.json,
plugin/mcp-proxy/package.json
Added zod version ^3.24.4 as a runtime dependency.
plugin/controller/lib/impl/mcp/MCPControllerRegister.ts Added static clean() method to MCPControllerRegister to reset the singleton instance and its state.
plugin/controller/app.ts Updated beforeClose to call MCPControllerRegister.clean() for cleanup during app shutdown.

Sequence Diagram(s)

sequenceDiagram
    participant App as ControllerAppBootHook
    participant MCP as MCPControllerRegister

    App->>MCP: clean()
    MCP->>MCP: Clear controllerProtos and reset instance
Loading

Suggested reviewers

  • killagu

Poem

In the code garden, zod seeds are sown,
Controllers now tidy when closing is known.
MCP cleans up, not a trace left behind,
With a hop and a sweep, all registers aligned.
🐇✨

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/app.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/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.

@akitaSummer akitaSummer requested a review from killagu May 14, 2025 12:56
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: 3

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1d9a7c7 and 3825730.

📒 Files selected for processing (5)
  • core/controller-decorator/package.json (1 hunks)
  • core/tegg/package.json (1 hunks)
  • core/tegg/zod.ts (1 hunks)
  • plugin/controller/package.json (1 hunks)
  • plugin/mcp-proxy/package.json (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: Socket Security: Pull Request Alerts
  • GitHub Check: Runner-ubuntu (20)
  • GitHub Check: Runner-ubuntu (22)
  • GitHub Check: Runner-macos (18)
  • GitHub Check: Runner-ubuntu (18)
  • GitHub Check: Runner-ubuntu (16)
  • GitHub Check: Runner-macos (20)
  • GitHub Check: Runner-macos (16)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (typescript)
🔇 Additional comments (2)
core/tegg/zod.ts (1)

1-1: Re-export of zod is correctly implemented
This passthrough module cleanly centralizes zod exports for downstream consumers.

core/tegg/package.json (1)

55-56: Review added runtime dependencies
This file introduces both @eggjs/tegg-types and zod under dependencies. While zod aligns with the PR’s goal, adding @eggjs/tegg-types wasn’t mentioned in the summary. Confirm whether @eggjs/tegg-types is required at runtime—if it’s only for type definitions, it may belong in devDependencies.

Run this script to check for usage:

#!/bin/bash
# Check usage of @eggjs/tegg-types and zod in core/tegg code
rg -n "from '@eggjs/tegg-types'" -A2 core/tegg
rg -n "import.*zod" -A2 core/tegg

Likely an incorrect or invalid review comment.

@akitaSummer akitaSummer force-pushed the fix/zod-phantom-dependency branch 5 times, most recently from cadf9ff to e309819 Compare May 14, 2025 14:37
@akitaSummer akitaSummer force-pushed the fix/zod-phantom-dependency branch from e309819 to 5078e15 Compare May 14, 2025 15:17
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: 0

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

149-154: Implement static method cleanup but address static context

The clean() method properly resets the singleton instance and clears controller prototypes for proper cleanup during application shutdown. However, using this in a static context could be confusing.

Consider using the class name instead of this for better clarity in the static context:

static clean() {
-  if (this.instance) {
-    this.instance.controllerProtos = [];
+  if (MCPControllerRegister.instance) {
+    MCPControllerRegister.instance.controllerProtos = [];
  }
-  this.instance = undefined;
+  MCPControllerRegister.instance = undefined;
}
🧰 Tools
🪛 Biome (1.9.4)

[error] 153-153: Using this in a static context can be confusing.

this refers to the class.
Unsafe fix: Use the class name instead.

(lint/complexity/noThisInStatic)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e309819 and 5078e15.

📒 Files selected for processing (5)
  • core/controller-decorator/package.json (1 hunks)
  • plugin/controller/app.ts (1 hunks)
  • plugin/controller/lib/impl/mcp/MCPControllerRegister.ts (1 hunks)
  • plugin/controller/package.json (1 hunks)
  • plugin/mcp-proxy/package.json (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • plugin/controller/package.json
  • plugin/mcp-proxy/package.json
  • core/controller-decorator/package.json
🧰 Additional context used
🧬 Code Graph Analysis (1)
plugin/controller/app.ts (1)
plugin/controller/lib/impl/mcp/MCPControllerRegister.ts (1)
  • MCPControllerRegister (69-510)
🪛 Biome (1.9.4)
plugin/controller/lib/impl/mcp/MCPControllerRegister.ts

[error] 153-153: Using this in a static context can be confusing.

this refers to the class.
Unsafe fix: Use the class name instead.

(lint/complexity/noThisInStatic)

⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: Runner-macos (18)
  • GitHub Check: Runner-ubuntu (22)
  • GitHub Check: Runner-ubuntu (18)
  • GitHub Check: Runner-ubuntu (16)
  • GitHub Check: Runner-ubuntu (20)
  • GitHub Check: Runner-macos (20)
  • GitHub Check: Runner-macos (16)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (typescript)
  • GitHub Check: Socket Security: Pull Request Alerts
🔇 Additional comments (1)
plugin/controller/app.ts (1)

130-130: LGTM! Great addition for consistent resource cleanup

Adding the MCPControllerRegister.clean() call in the beforeClose lifecycle method ensures proper cleanup of the MCP controller resources during application shutdown, similar to the existing HTTP controller cleanup pattern.

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

@killagu killagu merged commit e92372e into eggjs:master May 15, 2025
13 checks passed
This was referenced Jun 16, 2025
@coderabbitai coderabbitai bot mentioned this pull request Nov 18, 2025
4 tasks
@coderabbitai coderabbitai bot mentioned this pull request Dec 23, 2025
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