Skip to content
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

add http client #1

Merged
merged 5 commits into from
Jan 27, 2025
Merged

add http client #1

merged 5 commits into from
Jan 27, 2025

Conversation

Gaxeer
Copy link
Collaborator

@Gaxeer Gaxeer commented Jan 27, 2025

Add http client, update dependencies

@Gaxeer Gaxeer requested a review from Furrior January 27, 2025 16:59
Copy link

sourcery-ai bot commented Jan 27, 2025

Reviewer's Guide by Sourcery

This pull request introduces an HTTP client to the rust-utils library, along with a job system for handling asynchronous requests. It also includes necessary dependency updates and feature flags to manage the new functionality.

Class diagram for HTTP and Job System

classDiagram
    class RequestOptions {
        +Option~String~ output_filename
        +Option~String~ body_filename
    }

    class Response {
        +u16 status_code
        +HashMap~String,String~ headers
        +Option~str~ body
    }

    class RequestPrep {
        +Request req
        +Option~String~ output_filename
        +Vec~u8~ body
    }

    class Job {
        +Receiver~Output~ rx
        +JoinHandle handle
    }

    class Jobs {
        +HashMap~JobId,Job~ map
        +usize next_job
        +start()
        +check()
    }

    Jobs *-- Job
    note for Jobs "Manages async HTTP requests"
Loading

File-Level Changes

Change Details Files
Added an HTTP client with support for synchronous and asynchronous requests.
  • Implemented http_request_blocking for synchronous requests.
  • Implemented http_request_async for asynchronous requests using a job system.
  • Added http_check_request to check the status of asynchronous requests.
  • Added start_http_client and shutdown_http_client to manage the HTTP client lifecycle.
  • Added a job system for managing asynchronous tasks.
  • Added DM procs for calling the new HTTP functionality.
src/http.rs
src/jobs.rs
dmsrc/http.dm
Updated dependencies and added new ones for HTTP and async functionality.
  • Added ureq for HTTP client functionality.
  • Added flume for the job system.
  • Added once_cell for lazy initialization.
  • Added serde and serde_json for serialization and deserialization.
  • Updated the version of the crate.
  • Added feature flags for http, jobs, and other dependencies.
Cargo.toml
Modified error handling to include new HTTP-related errors.
  • Added JsonSerialization error for serde_json errors.
  • Added Request error for ureq errors.
src/error.rs
Modified file writing to return a Result instead of a BResult.
  • Changed the return type of the write function to use the new Result type alias.
src/file.rs
Added new modules to the library.
  • Added jobs module.
  • Added http module.
src/lib.rs

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We've reviewed this pull request using the Sourcery rules engine.

dmsrc/http.dm Outdated Show resolved Hide resolved
@Gaxeer Gaxeer merged commit a0a4025 into master Jan 27, 2025
2 checks passed
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.

2 participants