feat: exports undici #554

killagu · 2024-12-04T11:03:51Z

Summary by CodeRabbit

Bug Fixes
- Improved error handling and diagnostics publishing for fetch operations, ensuring errors are reported through the correct channel.
New Features
- Enhanced type definitions with new types for better type safety: BodyInit, ResponseInit, Headers, and FormData.
- Optimized handling of HTTP requests with caching for socket-based clients.
Documentation
- Updated export statements to maintain compatibility with existing libraries while enhancing functionality.

coderabbitai · 2024-12-04T11:03:59Z

Walkthrough

The changes in this pull request primarily involve modifications to the fetch method in the FetchFactory class located in src/fetch.ts, specifically regarding error handling and diagnostics publishing. The error messages are now published to a different channel, channels.fetchResponse, instead of channels.response. Additionally, the src/index.ts file has been updated to enhance type definitions and improve the handling of HTTP requests, including caching for socket connections and adjustments to export statements for compatibility.

Changes

File	Change Summary
src/fetch.ts	Modified error handling in `fetch` method to publish diagnostics to `channels.fetchResponse`. Corrected channel for response diagnostics.
src/index.ts	Updated export statements, added new types (`BodyInit`, `ResponseInit`, `Headers`, `FormData`), and improved handling of domain socket connections with `HttpClient` caching.

Possibly related PRs

fix: add export type #540: The changes in src/index.ts regarding export types may relate to the overall structure and type safety improvements in the codebase, which could indirectly affect how diagnostics are handled in src/fetch.ts.
test: run test on Node.js 23 #543: While this PR focuses on updating the CI configuration for Node.js versions, it may indirectly relate to the main PR if the changes in src/fetch.ts are tested against the new Node.js version, ensuring compatibility and correctness in error handling.

Suggested reviewers

fengmk2

Poem

In the burrow deep, where the fetchers play,
Errors now find a brighter way.
Channels shift, and types align,
Caching sockets, everything's fine!
Hops of joy in the code we see,
A happy rabbit, dancing with glee! 🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e06e7e9 and 4c3dbe8.

📒 Files selected for processing (2)

src/fetch.ts (1 hunks)
src/index.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

src/fetch.ts
src/index.ts

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 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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 104664d and e06e7e9.

📒 Files selected for processing (2)

src/fetch.ts (1 hunks)
src/index.ts (1 hunks)

🧰 Additional context used

🪛 eslint

src/fetch.ts

[error] 228-228: A space is required after ','.

(comma-spacing)

[error] 228-229: Missing trailing comma.

(comma-dangle)

🪛 GitHub Check: Node.js / Test (windows-latest, 23)

src/fetch.ts

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (windows-latest, 18.19.0)

src/fetch.ts

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 23)

src/fetch.ts

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 22)

src/fetch.ts

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 20)

src/fetch.ts

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 18.19.0)

src/fetch.ts

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 18)

src/fetch.ts

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (macos-latest, 23)

src/fetch.ts

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (macos-latest, 20)

src/fetch.ts

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (macos-latest, 18.19.0)

src/fetch.ts

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (macos-latest, 22)

src/fetch.ts

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (macos-latest, 18)

src/fetch.ts

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🔇 Additional comments (2)

src/index.ts (1)

47-48: LGTM: Enhanced type exports from undici

The additional type exports (BodyInit, ResponseInit, Headers, FormData, File) improve TypeScript support and type safety.

src/fetch.ts (1)

226-230: LGTM: Improved error handling with dedicated fetch response channel

The error is now correctly published to both channels.fetchResponse and channels.response, maintaining backward compatibility while providing fetch-specific error handling.

🧰 Tools

🪛 eslint

[error] 228-228: A space is required after ','.

(comma-spacing)

[error] 228-229: Missing trailing comma.

(comma-dangle)

🪛 GitHub Check: Node.js / Test (windows-latest, 23)

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (windows-latest, 18.19.0)

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 23)

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 22)

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 20)

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 18.19.0)

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 18)

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (macos-latest, 23)

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (macos-latest, 20)

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (macos-latest, 18.19.0)

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (macos-latest, 22)

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

🪛 GitHub Check: Node.js / Test (macos-latest, 18)

[failure] 228-228:
A space is required after ','

[failure] 228-228:
Missing trailing comma

src/fetch.ts

pkg-pr-new · 2024-12-04T11:13:51Z

Open in Stackblitz

npm i https://pkg.pr.new/node-modules/urllib@554

commit: 4c3dbe8

codecov · 2024-12-04T11:16:55Z

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Project coverage is 93.20%. Comparing base (104664d) to head (4c3dbe8).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
src/fetch.ts	0.00%	2 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #554   +/-   ##
=======================================
  Coverage   93.20%   93.20%           
=======================================
  Files          10       10           
  Lines        1222     1222           
  Branches      289      289           
=======================================
  Hits         1139     1139           
  Misses         79       79           
  Partials        4        4

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

[skip ci] ## [4.6.0](v4.5.1...v4.6.0) (2024-12-04) ### Features * exports undici ([#554](#554)) ([3c9fca7](3c9fca7))

feat: exports undici

e06e7e9

killagu assigned fengmk2, gxkl and akitaSummer Dec 4, 2024

coderabbitai bot reviewed Dec 4, 2024

View reviewed changes

src/fetch.ts Outdated Show resolved Hide resolved

f

4c3dbe8

fengmk2 approved these changes Dec 4, 2024

View reviewed changes

fengmk2 merged commit 3c9fca7 into master Dec 4, 2024
23 of 24 checks passed

fengmk2 deleted the exports/undici branch December 4, 2024 11:17

fengmk2 pushed a commit that referenced this pull request Dec 4, 2024

Release 4.6.0

12c4e3c

[skip ci] ## [4.6.0](v4.5.1...v4.6.0) (2024-12-04) ### Features * exports undici ([#554](#554)) ([3c9fca7](3c9fca7))

This was referenced Dec 4, 2024

fix: fix socket info if fetch failed #556

Merged

fix: set opaque on request #560

Merged

fix: should not throw when fetch a Request with post #563

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: exports undici #554

feat: exports undici #554

killagu commented Dec 4, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 4, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

pkg-pr-new bot commented Dec 4, 2024 •

edited

Loading

codecov bot commented Dec 4, 2024 •

edited

Loading

feat: exports undici #554

feat: exports undici #554

Conversation

killagu commented Dec 4, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Dec 4, 2024 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

pkg-pr-new bot commented Dec 4, 2024 • edited Loading

codecov bot commented Dec 4, 2024 • edited Loading

Codecov Report

killagu commented Dec 4, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 4, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented Dec 4, 2024 •

edited

Loading

codecov bot commented Dec 4, 2024 •

edited

Loading