fix: debug dont print full import object

[fengmk2]

Summary by CodeRabbit

• New Features

  • Introduced a new JavaScript module for configuration.

• Bug Fixes

  • Enhanced error handling for module resolution.
  • Improved clarity of debug logging during import processes.

• Tests

  • Added new test cases for importResolve to verify module path resolution and error handling.
  • Confirmed existing tests for importModule across various module types.

• Chores

  • Updated dependency versions in the package.json for the egg-app project.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
egg-utils	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 24, 2024 5:05pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces modifications to the module import functionality in src/import.ts. The changes primarily focus on enhancing error handling and debug logging for the importResolve and importModule functions. New TypeScript interfaces are added to provide better type definitions for import options. A new test fixture for an ESM configuration module is created, and additional test cases are added to verify the import resolution and module importing behaviors across different module types. Additionally, the package.json for the egg-app project has updated dependency versions.

Changes

File	Change Summary
src/import.ts	- Added ImportResolveOptions and ImportModuleOptions interfaces - Updated function signatures for importResolve and importModule - Enhanced error handling and modified debug logging statements
test/fixtures/esm/config/plugin.js	- Added new ESM configuration module with { foo: 'bar' } export
test/import.test.ts	- Added new test cases for importResolve() function - Verified module resolution and error handling for ESM imports
test/fixtures/egg-app/package.json	- Updated egg dependency from "*" to "beta" - Updated @eggjs/core dependency from "*" to "6"

Possibly related PRs

• feat: support import typescript files first at dev env #26: The changes in this PR enhance the importResolve function, which is also modified in the main PR, focusing on TypeScript support and module resolution.
• fix: try to read build dist file first #27: This PR modifies the importResolve function to improve handling of TypeScript modules, which aligns with the changes made in the main PR regarding error handling and module resolution.
• fix: should try to use esm module first #28: This PR emphasizes the usage of ECMAScript modules (ESM) in the import.ts file, which is relevant to the changes made in the main PR that also involve ESM handling in the importResolve function.

Poem

🐰 In the land of imports, we hop and play,

With paths that resolve in a graceful way.

Errors caught with a gentle touch,

Debug logs shining, we thank you much!

A new module added, oh what a delight,

Our code's now clearer, everything feels right! 🌟

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f79b932 and c65b260.

📒 Files selected for processing (1)

• src/import.ts (5 hunks)

---

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

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

[pkg-pr-new]

Open in Stackblitz

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

commit: c65b260

[codecov]

Codecov Report

Attention: Patch coverage is 50.00000% with 5 lines in your changes missing coverage. Please review.

Project coverage is 86.94%. Comparing base (88b08cf) to head (c65b260).
Report is 2 commits behind head on master.

Files with missing lines	Patch %	Lines
src/import.ts	50.00%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master      #29      +/-   ##
==========================================
- Coverage   87.50%   86.94%   -0.56%     
==========================================
  Files           6        6              
  Lines         600      605       +5     
  Branches       91       95       +4     
==========================================
+ Hits          525      526       +1     
- Misses         75       79       +4     

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/import.ts (1)

256-258: Keys-based logging improves privacy
By limiting the debug log to the object’s keys, the output is more concise and less likely to contain sensitive or overly verbose data, while still providing enough information for debugging.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 57d5863 and 8474f5a.

📒 Files selected for processing (3)

• src/import.ts (4 hunks)
• test/fixtures/esm/config/plugin.js (1 hunks)
• test/import.test.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• test/fixtures/esm/config/plugin.js

🔇 Additional comments (4)

test/import.test.ts (1)

14-17: Thorough test coverage for ESM plugin resolution
These newly added assertions validate both the successful resolution of esm/config/plugin and the expected error behavior for esm/config/plugin.default. The coverage effectively tests a key edge case to ensure that an erroneous path triggers the correct exception.

src/import.ts (3)

191-192: Ensure omission of sensitive data in debug logs
Logging options directly can inadvertently reveal sensitive information if such data is ever added to the ImportResolveOptions. Consider filtering or sanitizing the output if options can contain credentials or other private data in the future.

---

203-203: Concise and relevant debug statement
Logging the fileUrl instead of the entire imported object is a good way to keep debug logs uncluttered and maintain privacy.

---

246-246: Consistent logging across ESM and CJS imports
This debug statement mirrors the ESM counterpart, improving readability and consistency when tracing import flows.

[socket-security]

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/[email protected]	Transitive: environment, eval, filesystem, network, shell, unsafe	+77	5.95 MB	fengmk2

🚮 Removed packages: npm/[email protected]

View full report↗︎