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.

Sign up for GitHub

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

Jump to bottom

BaseHTTPClient: better constructor API, Default #1517

Merged
merged 3 commits into from
Aug 1, 2024
Merged

BaseHTTPClient: better constructor API, Default #1517

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7659dea
BaseHTTPClient: fields made public, better constructor API, Default
mvidner Jul 31, 2024
08f4369
BaseHTTPClient.client private again, +new_unauthenticated_with_url
mvidner Aug 1, 2024
7c155d2
BaseHTTPClient: just use the public base_url field
mvidner Aug 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 28 additions & 9 deletions rust/agama-lib/src/base_http_client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use reqwest::{header, Client, Response};
use reqwest::{header, Response};
use serde::{de::DeserializeOwned, Serialize};

use crate::{auth::AuthToken, error::ServiceError};
Expand All @@ -21,15 +21,36 @@ use crate::{auth::AuthToken, error::ServiceError};
/// }
/// ```
pub struct BaseHTTPClient {
client: Client,
pub client: reqwest::Client,
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this field public? IMHO, BaseHTTPClient should offer the API that fulfills our needs, and the reqwest::Client should be just an implementation detail. If we want to replace reqwest with something else (e.g., ureq) we can do it easily (or if reqwest API changes it might be easy to adapt).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It enables me constructing a mock client like this:

        let mock_client =  BaseHTTPClient {
            base_url: mock_url,
            ..Default::default()
        };

I chose this way because I did not want to come up with a special name for it.

Alternatively we can make it private again, remove the Default trait and make a set of specialized constructors, like new_unauthenticated_with_url here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Anyway, I consider BaseHTTPClient pretty volatile, subject to quick rewrite as its users need it

Copy link
Contributor

Choose a reason for hiding this comment

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

I was playing with an idea to implement some traits here and than do necessary changes in behavior in uderlying structs (which can even cover differences in using authorization token or not)

pub base_url: String,
}

const API_URL: &str = "http://localhost/api";

impl Default for BaseHTTPClient {
/// A `default` client
/// - is NOT authenticated (maybe you want to call `new` instead)
/// - uses `localhost`
fn default() -> Self {
Copy link
Contributor

Choose a reason for hiding this comment

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

In my POV default (or bare in my PR) are the best names ...
... I was thinking about something like new -> authorized and default / bare -> nonauthorized or something more fancy with similar meaning. Simply because behavior of new is not that clear (that it expects authorization token somewhere already)

Self {
client: reqwest::Client::new(),
base_url: API_URL.to_owned(),
}
}
}

impl BaseHTTPClient {
// if there is need for client without authorization, create new constructor for it
/// Uses `localhost`, authenticates with [`AuthToken`].
pub fn new() -> Result<Self, ServiceError> {
Ok(Self {
client: Self::authenticated_reqwest_client()?,
..Default::default()
})
}

fn authenticated_reqwest_client() -> Result<reqwest::Client, ServiceError> {
mvidner marked this conversation as resolved.
Show resolved Hide resolved
// TODO: this error is subtly misleading, leading me to believe the SERVER said it,
// but in fact it is the CLIENT not finding an auth token
let token = AuthToken::find().ok_or(ServiceError::NotAuthenticated)?;

let mut headers = header::HeaderMap::new();
Expand All @@ -39,12 +60,10 @@ impl BaseHTTPClient {

headers.insert(header::AUTHORIZATION, value);

let client = Client::builder().default_headers(headers).build()?;

Ok(Self {
client,
base_url: API_URL.to_string(), // TODO: add support for remote server
})
let client = reqwest::Client::builder()
.default_headers(headers)
.build()?;
Ok(client)
}

/// Simple wrapper around [`Response`] to get object from response.
Expand Down