Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: compatible with old version egg-core package name #38

Merged

Conversation

rrbe
Copy link
Contributor

@rrbe rrbe commented Jan 6, 2025

egg-bin v6 版本启动项目时,无法读到 cluster.listen.port 的配置

原因是 egg-bin 6.13.0 版本引入了 egg-utils v4,而 v4 在查找 egg-core 包时,包名从写死的 egg-core 改成了 @eggjs/core,如果 eggjs 版本没跟上,子依赖 egg-core 没升级,egg-utils 就会查找失败

截图_280f31b0-8db9-4fa3-9fdc-a17975625c5e

一种可能的解决方法是同时查找两个包名,如 PR 内容所示

Summary by CodeRabbit

  • Bug Fixes
    • Improved module import logic for the Egg framework
    • Enhanced backward compatibility with different module naming conventions
    • Streamlined error handling for module imports

Copy link

vercel bot commented Jan 6, 2025

@rrbe is attempting to deploy a commit to the no-veronica Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

coderabbitai bot commented Jan 6, 2025

Walkthrough

The changes modify the findEggCore function in src/plugin.ts to improve module import flexibility for the Egg framework. The function now supports importing modules using two different naming conventions: @eggjs/core and egg-core. By introducing an array of module names and iteratively attempting imports, the code enhances backward compatibility and provides more robust error handling for different versions of the Egg framework.

Changes

File Change Summary
src/plugin.ts - Modified findEggCore function to support multiple module import names
- Introduced names array with @eggjs/core and egg-core
- Implemented iterative module import logic
- Updated error handling and assertion mechanism

Poem

🥚 A Rabbit's Ode to Module Imports 🐰

Two names, one core, a framework's grace,
Import with care, leave no empty space!
Backward and forward, our code now dances,
Embracing change with nimble advances.
Egg-cellent imports, no errors in sight! 🎉


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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: 0

🧹 Nitpick comments (3)
src/plugin.ts (3)

136-137: Consider adding an English translation for this comment.

While this comment is informative, it mixes Chinese text with potentially global code usage contexts. Adding an English note could help non-Chinese speakers understand how and why the package rename is handled here.


137-145: Good backward compatibility approach – consider reducing duplicate logic.

Defining multiple package names in an array improves clarity and extensibility. However, the subsequent fallback logic in lines 148-154 repeats similar steps. Factoring this into a single function or more unified flow will enhance maintainability and readability.

- for (const name of names) {
-   try {
-     const { EggCore, EggLoader } = await importModule(name, { paths });
-     if (EggLoader) {
-       return { EggCore, EggLoader };
-     }
-   } catch (err: any) {
-     debug('[findEggCore] import "%s" from paths:%o error: %o', name, paths, err);
-   }
-   // ...
- }
+async function tryImportEggCore(name: string, paths?: string[]): Promise<{ EggCore?: object; EggLoader?: EggLoaderImplClass }> {
+  try {
+    const result = await importModule(name, paths ? { paths } : undefined);
+    if (result?.EggLoader) {
+      return result;
+    }
+  } catch (err) {
+    debug('[findEggCore] import "%s" from paths:%o error: %o', name, paths, err);
+  }
+  return {};
+}
+
+for (const name of names) {
+  let result = await tryImportEggCore(name, paths);
+  if (result?.EggLoader) return result;
+  result = await tryImportEggCore(name);
+  if (result?.EggLoader) return result;
+  // ...
+}

148-154: Repeated fallback logic could be wrapped into a helper.

You are attempting to import the same modules again but without custom paths. This repetition is functionally correct but could be cleaner if consolidated into a reusable helper or a single logic block.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9326f75 and f21ba79.

📒 Files selected for processing (1)
  • src/plugin.ts (1 hunks)
🔇 Additional comments (2)
src/plugin.ts (2)

166-166: Great error handling with a clear, consolidated message.

This ensures the code fails explicitly when no appropriate package is found, preventing ambiguous misconfigurations.


157-163: Directly referencing node_modules might fail in Yarn PnP or pnpm setups.

This approach explicitly relies on node_modules folder existence. It may not work in environments such as Yarn Plug’n’Play or pnpm which change or remove that traditional layout.

Below is a script to detect any Yarn Berry PnP config in the repository:

Copy link

pkg-pr-new bot commented Jan 7, 2025

Open in Stackblitz

npm i https://pkg.pr.new/eggjs/utils/@eggjs/utils@38

commit: f21ba79

@fengmk2
Copy link
Member

fengmk2 commented Jan 7, 2025

晚点我将 @egg/utils v4 改回去,它应该是要支持 egg v3 的,不应该 breaking。

@fengmk2 fengmk2 self-assigned this Jan 7, 2025
fengmk2 added a commit that referenced this pull request Jan 8, 2025
fengmk2 added a commit that referenced this pull request Jan 8, 2025
@fengmk2
Copy link
Member

fengmk2 commented Jan 8, 2025

晚点我将 @egg/utils v4 改回去,它应该是要支持 egg v3 的,不应该 breaking。

先按你的方式保持兼容

@fengmk2 fengmk2 merged commit c8b5dcc into eggjs:master Jan 8, 2025
21 of 22 checks passed
fengmk2 pushed a commit that referenced this pull request Jan 8, 2025
[skip ci]

## [4.2.5](v4.2.4...v4.2.5) (2025-01-08)

### Bug Fixes

* compatible with old version egg-core package name ([#38](#38)) ([c8b5dcc](c8b5dcc))
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