Skip to content

use an OffsetDateTime on the ClientStats #244

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

Merged
merged 1 commit into from
Mar 2, 2022
Merged

use an OffsetDateTime on the ClientStats #244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion src/client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ use crate::{
use serde::Deserialize;
use serde_json::{json, Value};
use std::{collections::HashMap, time::Duration};
use time::OffsetDateTime;

/// The top-level struct of the SDK, representing a client containing [indexes](../indexes/struct.Index.html).
#[derive(Debug, Clone)]
Expand Down Expand Up @@ -588,7 +589,8 @@ impl Client {
#[serde(rename_all = "camelCase")]
pub struct ClientStats {
pub database_size: usize,
pub last_update: Option<String>,
#[serde(with = "time::serde::rfc3339::option")]
pub last_update: Option<OffsetDateTime>,
Copy link
Member

Choose a reason for hiding this comment

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

Should I be worried because no tests were changed and, we still have the CI passing? 😅

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I totally get your concern ahah!

We actually have only one test on this route:

use meilisearch_sdk::{client::*, indexes::*};
futures::executor::block_on(async move {
  let client = Client::new("http://localhost:7700", "masterKey");
  let stats = client.get_stats().await.unwrap();
});

And the unwrap right there ensure we were able to parse the new date format: client.get_stats().await.unwrap();

On another note I'm wondering if we could add more tests though, but we can't test a lot of things because we don't know what the database_size is supposed to be, we don't really know the time of the last_update or what indexes are in the Client currently 🤔

pub struct ClientStats {
    pub database_size: usize,
    pub last_update: Option<String>,
    pub indexes: HashMap<String, IndexStats>,
}

One test we could add though would be to create an index and ensure we find it later in the stats + ensure the time of the last_update >= the time we sent our update but that feel like testing meilisearch more than meilisearch-rust, what do you think?

Copy link
Member

Choose a reason for hiding this comment

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

I totally agree with that idea! Or maybe if it is possible you could create a mock of the API response, adding a specific value in the database_size and last_update it will make it easier to test after that. But of course, this mock need only is used in the raw response of the API, to ensure the crate will be able to parse it accordingly.

I think this way you could have the whole TDD flow :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Creating a mock would be the best thing, but I don't have the time currently, sadly 😒
We could open an issue, though, I think faux would be really suited for this library 👍

pub indexes: HashMap<String, IndexStats>,
}

Expand Down
2 changes: 1 addition & 1 deletion src/tasks.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ impl Task {
/// # futures::executor::block_on(async move {
/// # let client = Client::new("http://localhost:7700", "masterKey");
/// let task = client
/// .create_index("is_success", None)
/// .create_index("is_pending", None)
/// .await
/// .unwrap();
///
Expand Down