search

node-modules / urllib

Request HTTP(s) URLs in a complex world.
MIT License
726 stars 118 forks source link

feat: support HTTP2 #518

Closed fengmk2 closed 3 months ago

fengmk2 commented 3 months ago

closes https://github.com/node-modules/urllib/issues/474

pick from https://github.com/node-modules/urllib/pull/516

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent changes introduce HTTP/2 support in the HttpClient through an allowH2 option. This update allows users to enable HTTP/2 when creating HTTP clients, enhancing Server-Sent Events (SSE) support. Modifications span across HttpClient, HttpAgent, and corresponding test files, along with README documentation to illustrate the new feature. Additionally, the Node.js workflow in the GitHub Actions configuration has been updated to support more versions.

Changes

File Change Summary
README.md Added section demonstrating HTTP/2 usage with HttpClient.
src/HttpAgent.ts Introduced allowH2 property in HttpAgentOptions and updated constructor.
src/HttpClient.ts Included allowH2 in ClientOptions and adjusted class instantiation logic.
test/HttpClient.test.ts Added tests for allowH2 and exported getGlobalDispatcher.
.github/workflows/nodejs.yml Corrected and expanded Node.js version list.

Sequence Diagram(s)

sequenceDiagram
    participant User as User
    participant Application as Application
    participant HttpClient as HttpClient
    participant HttpAgent as HttpAgent
    participant Server as Server

    Note over User, Application: Initial Client Setup
    User->>Application: Create HttpClient with allowH2
    Application->>HttpClient: New HttpClient({ allowH2: true })
    HttpClient->>HttpAgent: Instantiate HttpAgent with allowH2

    Note over Application, Server: Making a Request
    Application->>HttpClient: Make HTTP request
    HttpClient->>HttpAgent: Get Connection
    HttpAgent->>Server: Connect (HTTP/2 if supported)
    Server->>HttpAgent: Respond
    HttpAgent->>HttpClient: Relay Response
    HttpClient->>Application: Return Response
    Application->>User: Display Results

Assessment against linked issues

Objective Addressed Explanation
Support HTTP2 to make SSE easy [#474] ✅

Poem

In the world of bytes and code so spruce,
Comes a client that sips HTTP2 juice.
With allowH2, the streams now breeze,
Over the wires where data leads.
From client to server, a path anew,
A rabbit's dream in a world brand new.
🌐🐰🚀

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 97.86%. Comparing base (8247aa2) to head (9b0c129).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #518 +/- ## ========================================== + Coverage 97.85% 97.86% +0.01% ========================================== Files 10 10 Lines 1586 1596 +10 Branches 255 256 +1 ========================================== + Hits 1552 1562 +10 Misses 30 30 Partials 4 4 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.