konevsa/proxmox.newest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

client: fix optional data for errors

Browse Source 
previously we changed the internal type of the 'data' property
from Option<T> to T in the assumption the api always returns
'data:null'.

this is actually only the case when the api call succeeds. in an error
case there is no data property at all.

to fix this issue while behaving the same for 'data:null' we have to
revert to Option<T> for RawApiResponse but instead of always throwing an
error for 'data:null' in 'check' we now try there to deserialize from
Value::Null for T if there was no data. This will succeed for the Type
'()' which was the motivation for the original change.

The only downside is that the RawApiResponse now has a trait bound that
T is deserializeable, but was a requirement for using it anyway
(as there was no other way of constructing it)

Fixes: 271a55f ("client: remove option from inner RawApiResponse")
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
This commit is contained in:
Dominik Csapak 2023-09-14 12:41:30 +02:00 committed by Wolfgang Bumiller
parent dc9ee73751
commit 9fa4185196
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
proxmox-client/src/lib.rs
View File

@ -106,7 +106,7 @@ impl HttpApiResponse {
/// Expect that the API call did *not* return any data in the `data` field.
pub fn nodata(self) -> Result<(), Error> {
let response = serde_json::from_slice::<RawApiResponse<Option<()>>>(&self.body)
let response = serde_json::from_slice::<RawApiResponse<()>>(&self.body)
.map_err(|err| Error::bad_api("unexpected api response", err))?;
if response.data.is_some() {
@ -131,7 +131,7 @@ struct RawApiResponse<T> {
message: Option<String>,
#[serde(default, deserialize_with = "proxmox_login::parse::deserialize_bool")]
success: Option<bool>,
data: T,
data: Option<T>,
#[serde(default)]
errors: HashMap<String, String>,
@ -140,7 +140,10 @@ struct RawApiResponse<T> {
attribs: HashMap<String, Value>,
}
impl<T> RawApiResponse<T> {
impl<T> RawApiResponse<T>
where
T: for<'de> Deserialize<'de>,
{
fn check_success(mut self) -> Result<Self, Error> {
if self.success == Some(true) {
return Ok(self);
@ -163,8 +166,16 @@ impl<T> RawApiResponse<T> {
fn check(self) -> Result<ApiResponseData<T>, Error> {
let this = self.check_success()?;
// RawApiResponse has no data, but this also happens for Value::Null, and T
// might be deserializeable from that, so try here again
let data = match this.data {
Some(data) => data,
None => serde_json::from_value(Value::Null)
.map_err(|_| Error::BadApi("api returned no data".to_string(), None))?,
};
Ok(ApiResponseData {
data: this.data,
data,
attribs: this.attribs,
})
}