fix: should handle ./ relative path

[bytemain]

We have a tgz its entry path is ./foo/bar, and when invoke stripFileName(1, './foo/bar'), it always return foo/bar, actually, we expect it to return bar

Summary by CodeRabbit

• Bug Fixes

  • Improved handling of file paths to ensure consistent formatting across different operating systems.

• Tests

  • Added new test cases to verify correct behavior when normalizing and stripping relative file paths.

[coderabbitai]

Walkthrough

A new normalizePath helper function was introduced in the utility module to standardize file path formatting, especially for Windows paths. The stripFileName function was refactored to use this new helper for consistent normalization. Corresponding tests were added to verify correct handling of relative paths and directory stripping.

Changes

File(s)	Change Summary
lib/utils.js	Added normalizePath(fileName) to standardize file paths; refactored stripFileName to use this new function.
test/utils.test.js	Added tests for stripFileName to cover normalization of relative paths and directory stripping scenarios.

Poem

A path is a path, but not always the same—
With slashes and dots, it plays quite the game.
Now normalized neat, on Windows or not,
Our tests hop along, each bug soon forgot.
🐇✨ Paths in a row, like carrots they grow!

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.

test/utils.test.js

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".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

lib/utils.js

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".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

---

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

lib/utils.js (1)

193-193: Consider consolidating path normalization logic.

There's currently duplicate logic for handling backslashes in both line 193 (explicit replacement) and in the new normalizePath function (for Windows). Consider moving all path normalization into normalizePath for better maintainability.

 // use / instead of \\ -if (fileName.indexOf('\\') !== -1) fileName = fileName.replace(/\\+/g, '/');+// Backslash normalization will be handled by normalizePath // fix absolute path // /foo => foo if (fileName[0] === '/') fileName = fileName.replace(/^\/+/, ''); // fix case // ./foo/bar => foo/bar if (fileName){fileName = normalizePath(fileName)}

Also applies to: 199-203

test/utils.test.js (1)

56-58: Consider adding more complex path combination tests.

While the current tests cover the basic ./ scenarios, consider adding tests with more complex combinations like ./foo/../bar to ensure that all edge cases are properly handled by the normalization logic.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between d173d2d and 7724be0.

📒 Files selected for processing (2)

• lib/utils.js (2 hunks)
• test/utils.test.js (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Node.js / Test (windows-latest, 16)
• GitHub Check: Node.js / Test (windows-latest, 18)
• GitHub Check: Node.js / Test (windows-latest, 14)

🔇 Additional comments (3)

lib/utils.js (2)

171-176: Good addition of the normalizePath function.

This helper function correctly normalizes file paths by using path.normalize and handles Windows backslashes properly. This abstraction will make path handling more consistent throughout the codebase.

---

199-203: Well implemented fix for handling ./ relative paths.

The changes correctly address the issue described in the PR objectives by ensuring that paths prefixed with ./ are properly normalized before stripping occurs. This allows stripFileName(1, './foo/bar') to correctly return bar instead of foo/bar.

test/utils.test.js (1)

56-58: Good test coverage for the new functionality.

These test cases properly validate the new behavior for handling paths prefixed with ./, including both normalization (when strip=0) and directory level stripping (when strip=1). The third test case specifically verifies the fix described in the PR objectives.

[bytemain]

The failure of CI doesn't seem to be related to this fix. I don't have the permission to rerun the CI. Can you help me retry it?

@fengmk2

[fengmk2]

@bytemain sure, also invite you to join node-modules owner team :)

[bytemain]

Thanks! Finally accepted by the organization.