fix: support export default null

[fengmk2]

Summary by CodeRabbit

• Bug Fixes

  • Improved compatibility with CommonJS modules simulating ES modules by updating condition checks when importing modules.

• Tests

  • Added test cases to support scenarios where modules have null as the default export.

[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	Jun 17, 2024 2:18pm

[coderabbitai]

Walkthrough

The updates primarily involve refining the importModule function in src/import.ts to ensure better compatibility with CommonJS modules that mimic ES modules. Additionally, new test fixtures and cases are introduced to handle scenarios where modules export null, ensuring robustness and comprehensive module import functionality.

Changes

Files	Change Summary
src/import.ts	Updated condition checks in importModule for better compatibility with CommonJS modules.
test/fixtures/cjs/module-exports-null.js	Introduced a new fixture assigning null to module.exports.
test/fixtures/esm/export-default-null.js	Introduced a new fixture with a default export of null.
test/import.test.ts	Added test cases to cover scenarios of importing modules with null as the default export.

Sequence Diagram(s)

sequenceDiagram
    participant Tester
    participant ImportModule
    participant CJSModule
    participant ESMModule

    Tester->>ImportModule: importModule('module-exports-null.js')
    ImportModule->>CJSModule: require('module-exports-null.js')
    CJSModule-->>ImportModule: returns null
    ImportModule-->>Tester: returns null

    Tester->>ImportModule: importModule('export-default-null.js')
    ImportModule->>ESMModule: import('export-default-null.js')
    ESMModule-->>ImportModule: returns { default: null }
    ImportModule-->>Tester: returns null

Loading

Poem

In the code where bugs can dwell,
Compatibility whispers, "All is well."
Import with joy, modules of null,
In tests, resilience, stories they tell.
The rabbit hops with clever might,
Ensuring imports work just right. 🌟

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 85555be and 81d2dbd.

Files selected for processing (4)

• src/import.ts (2 hunks)
• test/fixtures/cjs/module-exports-null.js (1 hunks)
• test/fixtures/esm/export-default-null.js (1 hunks)
• test/import.test.ts (1 hunks)

Files skipped from review due to trivial changes (2)

• test/fixtures/cjs/module-exports-null.js
• test/fixtures/esm/export-default-null.js

Additional comments not posted (4)

src/import.ts (2)

38-38: Ensure compatibility with CommonJS modules simulating ES modules by checking for the existence of the 'default' key.

---

75-75: Ensure that the importDefaultOnly option correctly handles scenarios where only the default export should be imported.

test/import.test.ts (2)

87-97: The new test cases effectively verify the functionality of handling module.exports = null with both importDefaultOnly true and false.

---

99-109: The new test cases effectively verify the functionality of handling export default null with both importDefaultOnly true and false.

[codecov]

Codecov Report

Attention: Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 87.65%. Comparing base (a37968c) to head (81d2dbd).
Report is 1 commits behind head on master.

Files	Patch %	Lines
src/import.ts	50.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##           master      #22   +/-   ##
=======================================
  Coverage   87.65%   87.65%           
=======================================
  Files           6        6           
  Lines         413      413           
  Branches       53       53           
=======================================
  Hits          362      362           
  Misses         51       51           

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