Skip to content

feat: add urllib4 fetch #5424

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

Merged
merged 7 commits into from
Jul 4, 2025
Merged

feat: add urllib4 fetch #5424

merged 7 commits into from
Jul 4, 2025

Conversation

killagu
Copy link
Contributor

@killagu killagu commented Jul 3, 2025

No description provided.

Copy link

vercel bot commented Jul 3, 2025

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

Name Status Preview Comments Updated (UTC)
egg ❌ Failed (Inspect) Jul 4, 2025 8:23am

Copy link

coderabbitai bot commented Jul 3, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @killagu, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request integrates the modern fetch API provided by urllib4 into the application framework. It's designed to be forward-compatible, activating this new functionality only when running on Node.js 18 or newer, thereby enhancing the application's HTTP client capabilities for modern environments without breaking existing setups.

Highlights

  • New Feature: urllib4 Fetch API: Introduced the fetch API functionality from urllib4, providing a modern way to make HTTP requests within the application.
  • Conditional Node.js Version Support: The urllib4 integration is conditionally enabled only for Node.js environments running version 18 or higher, ensuring compatibility with older Node.js versions while leveraging newer capabilities.
  • Application Instance Exposure: The FetchFactory and fetch function are now exposed directly on the app instance (e.g., app.fetch), making them easily accessible throughout the application.
  • New Test Coverage: Added dedicated unit tests for the fetch_factory module to verify the correct functionality of the urllib4 fetch integration.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

cloudflare-workers-and-pages bot commented Jul 3, 2025

Deploying egg-v3 with  Cloudflare Pages  Cloudflare Pages

Latest commit: ab5b5bc
Status: ✅  Deploy successful!
Preview URL: https://0d404f25.egg-v3.pages.dev
Branch Preview URL: https://feat-fetch.egg-v3.pages.dev

View logs

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces urllib4's fetch capabilities to the application, providing a modern alternative for making HTTP requests. The changes include updating type definitions, conditionally loading urllib4 based on the Node.js version, and integrating the FetchFactory and fetch methods into the EggApplication class. My review identified a few areas for improvement related to maintainability, configuration, and crucially, security, specifically regarding SSRF protection for the new fetch API.

@@ -51,6 +52,11 @@ class EggApplication extends EggCore {
this.ContextHttpClient = ContextHttpClient;
this.HttpClient = HttpClient;
this.HttpClientNext = HttpClientNext;
this.FetchFactory = FetchFactory;
if (FetchFactory) {
this.FetchFactory.setClientOptions();

Choose a reason for hiding this comment

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

high

The FetchFactory.setClientOptions() method is called without any arguments. In lib/core/httpclient.js and lib/core/httpclient_next.js, HttpClient and HttpClientNext are initialized with app.config.httpclient to apply global HTTP client settings (like timeouts, keep-alive agents, etc.). It's highly probable that FetchFactory also needs to be configured with these settings to ensure fetch requests behave consistently with other HTTP requests in the application. Without proper configuration, fetch might not respect the configured timeouts, agents, or other crucial settings, leading to unexpected behavior or performance issues.

Suggested change
this.FetchFactory.setClientOptions();
this.FetchFactory.setClientOptions(this.config.httpclient);

Copy link

cloudflare-workers-and-pages bot commented Jul 3, 2025

Deploying egg with  Cloudflare Pages  Cloudflare Pages

Latest commit: ab5b5bc
Status: ✅  Deploy successful!
Preview URL: https://0173dc80.egg-cci.pages.dev
Branch Preview URL: https://feat-fetch.egg-cci.pages.dev

View logs

Copy link

codecov bot commented Jul 3, 2025

Codecov Report

Attention: Patch coverage is 91.30435% with 4 lines in your changes missing coverage. Please review.

Project coverage is 99.58%. Comparing base (37aabaa) to head (ab5b5bc).
Report is 1 commits behind head on 3.x.

Files with missing lines Patch % Lines
lib/core/fetch_factory.js 89.18% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##              3.x    #5424      +/-   ##
==========================================
- Coverage   99.69%   99.58%   -0.11%     
==========================================
  Files          35       36       +1     
  Lines        3609     3653      +44     
  Branches      538      544       +6     
==========================================
+ Hits         3598     3638      +40     
- Misses         11       15       +4     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@killagu killagu changed the title feat: add urllib4 fetch WIP: feat: add urllib4 fetch Jul 3, 2025
@killagu killagu changed the title WIP: feat: add urllib4 fetch feat: add urllib4 fetch Jul 3, 2025
@fengmk2 fengmk2 enabled auto-merge (squash) July 3, 2025 12:31
@fengmk2 fengmk2 changed the base branch from master to 3.x July 3, 2025 12:34
@fengmk2
Copy link
Member

fengmk2 commented Jul 3, 2025

@killagu 改成 3.x 分支,我忘记将 master 删除了 https://github.com/eggjs/egg/tree/3.x

thonatos and others added 7 commits July 4, 2025 16:23
- add v3 link to nav menu
- remove vercel config
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@fengmk2 fengmk2 merged commit 63d14da into 3.x Jul 4, 2025
2 of 5 checks passed
@fengmk2 fengmk2 deleted the feat/fetch branch July 4, 2025 08:23
fengmk2 pushed a commit that referenced this pull request Jul 4, 2025
[skip ci]

## [3.31.0](v3.30.1...v3.31.0) (2025-07-04)

### Features

* add urllib4 fetch ([#5424](#5424)) ([63d14da](63d14da))
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.

3 participants