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: normalize Windows paths in ModuleId constructors #1744

Merged
merged 1 commit into from
Jan 8, 2025
Merged

Conversation

sorrycc
Copy link
Member

@sorrycc sorrycc commented Jan 8, 2025

Close #1668

Summary by CodeRabbit

  • 重构
    • 更新了 ModuleId 结构体的 ID 处理方式,现在使用 win_path 函数对 ID 进行标准化处理。
    • 修改了从不同类型(String&strPathBuf)创建 ModuleId 实例的方法,确保 ID 格式一致性。

Copy link
Contributor

coderabbitai bot commented Jan 8, 2025

概述

演练

此次更改主要修改了 ModuleId 结构体中的 id 字段处理方式。通过在构造函数和各种 From 特征实现中引入 win_path 函数,确保了 ModuleId 实例的 id 字段在不同创建方式下都能得到一致的路径格式化处理。这些修改旨在解决 Windows 构建过程中可能出现的模块路径问题。

变更

文件 变更概要
crates/mako/src/module.rs - ModuleId 构造函数现在使用 win_path 处理 id
- From<String> 特征实现使用 win_path 格式化 id
- From<&str> 特征实现使用 win_path 处理输入
- From<PathBuf> 特征实现通过 win_path 转换路径

针对链接问题的评估

目标 已解决 说明
Windows 构建中模块图问题 [#1668]

可能相关的 PR

诗歌

🐰 路径迷踪,Windows 迷障
代码兔轻跳,win_path 显神通
模块 ID 整装,构建无忧
兔子魔法,代码飞扬!
🚀✨


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

Walkthrough

This pull request addresses the issue of normalizing Windows paths in the ModuleId constructors. The changes ensure that paths are consistently formatted using the win_path function, which is applied across various constructors for ModuleId to handle different input types such as String, &str, and PathBuf.

Changes

File Summary
crates/mako/src/module.rs Updated ModuleId constructors to normalize Windows paths using the win_path function for String, &str, and PathBuf inputs.

@@ -282,7 +282,9 @@ impl PartialOrd for ModuleId {
impl ModuleId {
// we use absolute path as module id now
pub fn new(id: String) -> Self {
Self { id }
Self {
id: win_path(id.as_str()),

Choose a reason for hiding this comment

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

Ensure that the win_path function correctly handles all edge cases for path normalization, especially for paths that may contain special characters or invalid sequences.

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

🧹 Nitpick comments (1)
crates/mako/src/module.rs (1)

324-324: 建议优化 PathBuf 转换链!

当前实现使用了多次字符串转换:to_string_lossy().to_string().as_str()。建议简化转换链以提高效率。

-            id: win_path(path.to_string_lossy().to_string().as_str()),
+            id: win_path(path.to_string_lossy().as_ref()),
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dfe3164 and 31f7883.

📒 Files selected for processing (1)
  • crates/mako/src/module.rs (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (13)
  • GitHub Check: stable - i686-pc-windows-msvc - node@20
  • GitHub Check: stable - x86_64-pc-windows-msvc - node@20
  • GitHub Check: Clippy
  • GitHub Check: Mako Build (macos-latest)
  • GitHub Check: stable - aarch64-unknown-linux-musl - node@20
  • GitHub Check: stable - aarch64-unknown-linux-gnu - node@20
  • GitHub Check: Cargo Test
  • GitHub Check: stable - x86_64-unknown-linux-musl - node@20
  • GitHub Check: Code Coverage
  • GitHub Check: stable - x86_64-unknown-linux-gnu - node@20
  • GitHub Check: Mako Build (ubuntu-latest)
  • GitHub Check: stable - aarch64-apple-darwin - node@20
  • GitHub Check: stable - x86_64-apple-darwin - node@20
🔇 Additional comments (3)
crates/mako/src/module.rs (3)

285-287: 路径规范化实现正确!

构造函数中正确使用了 win_path 函数来规范化路径,实现符合预期。


309-311: String 转换实现保持一致性!

From<String> 实现与构造函数保持一致,同样使用 win_path 进行路径规范化,很好!


317-317: &str 转换实现简洁有效!

From<&str> 实现采用了更简洁的写法,同时保持了路径规范化的一致性。

Copy link

codecov bot commented Jan 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.81%. Comparing base (dfe3164) to head (31f7883).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1744   +/-   ##
=======================================
  Coverage   54.80%   54.81%           
=======================================
  Files         180      180           
  Lines       18079    18081    +2     
=======================================
+ Hits         9909     9911    +2     
  Misses       8170     8170           

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

@sorrycc sorrycc merged commit 66535b5 into master Jan 8, 2025
22 checks passed
@sorrycc sorrycc deleted the sorrycc-h19k branch January 8, 2025 06:17
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.

Windows build 出现 not found in the module graph
1 participant