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: node ignore should support node: prefixed only built-in modules #1721

Merged
merged 1 commit into from
Dec 12, 2024

Conversation

sorrycc
Copy link
Member

@sorrycc sorrycc commented Dec 12, 2024

Re-implementation #1716

Summary by CodeRabbit

  • 新功能
    • 引入对 node:sqlite 模块的支持,确保在转换输出中保留相关的 require 语句。
  • 测试
    • 添加了新的断言以验证 require('node:sqlite'); 的存在。

Copy link
Contributor

coderabbitai bot commented Dec 12, 2024

Walkthrough

该拉取请求主要对Node结构体的modify_config方法进行了修改,重点在于如何处理内置的Node.js模块。具体而言,使用新的方法get_all_builtin_modules()替代了原有的get_all_node_modules(),并改进了用于忽略内置模块的正则表达式模式。此外,还在index.js文件中添加了对node:sqlite模块的导入,并在测试中增加了相应的断言,以确保该模块的引入。

Changes

文件路径 更改摘要
crates/mako/src/features/node.rs - 方法签名更新:get_all_node_modules()get_node_prefixed_only_builtin_modules()
- 新增方法:get_all_builtin_modules()
- 新方法:get_all_builtin_modules_besides_node_prefixed_only()
e2e/fixtures/config.platform.node/expect.js - 新增断言:验证require('node:sqlite');是否存在于index.js文件内容中。
e2e/fixtures/config.platform.node/src/index.ts - 新增模块导入:require('node:sqlite');

Possibly related PRs

  • fix: node ignores #1716: 此PR修改了Node结构体中的modify_config方法,以添加一个正则表达式模式,用于忽略以"node:"开头的内置Node.js模块,这与主PR中关于内置模块处理的更改直接相关。

🐰 在代码的草地上,
新模块悄然来,
忽略的规则变,
兔子欢快舞起来!
node:sqlite在此,
让我们一起欢呼吧!
🎉


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. (Experiment)
  • @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
Contributor

@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

🧹 Outside diff range and nitpick comments (5)
e2e/fixtures/config.platform.node/src/index.ts (1)

20-21: 导入语句格式建议

建议在导入语句块中统一管理所有的 require 调用,而不是分散在代码中。这样可以提高代码的可维护性和可读性。

建议将代码重构为:

import { ENCODING } from './constants';
import fs1 from 'fs';
import fs2 from 'node:fs';
import { readFile } from 'fs/promises';

+ require('http2');
+ require('crypto');
+ require('node:sqlite');
+
fs1.readFileSync(__filename, ENCODING);
fs2.readFileSync(__filename, ENCODING);
readFile(__filename, { encoding: ENCODING });

console.log('dirname', __dirname);

- require('http2');
-
- try {
-   require('crypto')
-   hasCrypto = true
- } catch {
-   hasCrypto = false
- }
-
- require('node:sqlite');
+ try {
+   hasCrypto = true
+ } catch {
+   hasCrypto = false
+ }
e2e/fixtures/config.platform.node/expect.js (1)

38-38: 测试用例补充完善

测试用例正确验证了 node:sqlite 模块的保留,但建议同时添加负向测试用例,验证非 node: 前缀的 sqlite 模块是否被正确处理。

建议添加如下测试:

assert(!content.includes(`require('sqlite');`), `should not keep require for non-node: prefixed sqlite`);
crates/mako/src/features/node.rs (3)

24-29: 正则表达式模式优化建议

当前实现使用了两个独立的正则表达式来匹配模块,这可能导致性能开销增加。建议合并为单个正则表达式以提高效率。

建议重构为:

- config.ignores.push(format!(
-     "^({})(/.+|$)",
-     Self::get_all_builtin_modules_besides_node_prefixed_only().join("|")
- ));
- config.ignores.push(format!(
-     "^node:({})(/.+|$)",
-     Self::get_all_builtin_modules().join("|")
- ));
+ config.ignores.push(format!(
+     "^(?:node:)?({})(/.+|$)",
+     Self::get_all_builtin_modules().join("|")
+ ));

130-132: 内置模块列表维护建议

get_node_prefixed_only_builtin_modules 方法中的模块列表是硬编码的,这可能导致维护困难。建议将模块列表移至配置文件中,便于后续更新和维护。

建议创建一个配置文件来管理这些模块列表,例如:

// node_modules.config.json
{
  "nodePrefixedOnlyModules": ["sqlite", "test"],
  "polyfillModules": [...],
  "emptyModules": [...]
}

134-138: 代码复杂度优化建议

get_all_builtin_modules 方法的实现可以更简洁。当前实现需要创建新的 Vec 并扩展,这会带来额外的内存分配。

建议重构为:

fn get_all_builtin_modules() -> Vec<String> {
    let mut modules = Self::get_all_builtin_modules_besides_node_prefixed_only();
    modules.extend(Self::get_node_prefixed_only_builtin_modules());
    modules.sort();
    modules.dedup();
    modules
}

添加了 sortdedup 操作以确保模块列表的唯一性和排序。

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fb93c47 and 2544adb.

📒 Files selected for processing (3)
  • crates/mako/src/features/node.rs (2 hunks)
  • e2e/fixtures/config.platform.node/expect.js (1 hunks)
  • e2e/fixtures/config.platform.node/src/index.ts (1 hunks)

Copy link

codecov bot commented Dec 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.89%. Comparing base (6bee118) to head (2544adb).
Report is 4 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1721      +/-   ##
==========================================
- Coverage   54.92%   54.89%   -0.03%     
==========================================
  Files         178      178              
  Lines       17843    17871      +28     
==========================================
+ Hits         9800     9811      +11     
- Misses       8043     8060      +17     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sorrycc sorrycc merged commit 0eeb4af into master Dec 12, 2024
19 of 20 checks passed
@sorrycc sorrycc deleted the sorrycc-6jyd branch December 12, 2024 08:27
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.

1 participant