Skip to content

feat: Capture request-id in the OpenStack API error #1391

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
gtema merged 1 commit into from
Sep 2, 2025
Merged

feat: Capture request-id in the OpenStack API error #1391

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
143 changes: 119 additions & 24 deletions openstack_sdk/src/api/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
use std::any;
use std::error::Error;

use http::Uri;
use bytes::Bytes;
use http::{Response, Uri};
use thiserror::Error;

use crate::api::PaginationError;
Expand Down Expand Up @@ -87,10 +88,11 @@ where
},
/// OpenStack returned understandable error message
#[error(
"openstack server error:\n\turi: `{}`\n\tstatus: `{}`\n\tmessage: `{}`",
"openstack server error:\n\turi: `{}`\n\tstatus: `{}`\n\tmessage: `{}`\n\trequest-id: `{}`",
uri,
status,
msg
msg,
req_id.as_deref().unwrap_or("")
)]
OpenStack {
/// The status code for the return.
Expand All @@ -99,12 +101,15 @@ where
uri: Uri,
/// The error message from OpenStack.
msg: String,
/// Request ID
req_id: Option<String>,
},
/// OpenStack returned an error without JSON information.
#[error(
"openstack internal server error:\n\turi: `{}`\n\tstatus: `{}`",
"openstack internal server error:\n\turi: `{}`\n\tstatus: `{}`\n\trequest-id: `{}`",
uri,
status
status,
req_id.as_deref().unwrap_or("")
)]
OpenStackService {
/// The status code for the return.
Expand All @@ -113,13 +118,16 @@ where
uri: Uri,
/// The error data from OpenStack.
data: String,
/// Request ID
req_id: Option<String>,
},
/// OpenStack returned an HTTP error with JSON we did not recognize.
#[error(
"openstack server error:\n\turi: `{}`\n\tstatus: `{}`\n\tdata: `{}`",
"openstack server error:\n\turi: `{}`\n\tstatus: `{}`\n\tdata: `{}`\n\trequest-id: `{}`",
uri,
status,
obj
obj,
req_id.as_deref().unwrap_or("")
)]
OpenStackUnrecognized {
/// The status code for the return.
Expand All @@ -128,6 +136,8 @@ where
uri: Uri,
/// The full object from OpenStack.
obj: serde_json::Value,
/// Request ID
req_id: Option<String>,
},
/// Failed to parse an expected data type from JSON.
#[error("could not parse {} data from JSON: {}", typename, source)]
Expand Down Expand Up @@ -168,36 +178,51 @@ where
/// Process server response with no Json body
pub(crate) fn server_error(
uri: Option<Uri>,
status: http::StatusCode,
rsp: &Response<Bytes>,
body: &bytes::Bytes,
) -> Self {
// Non Json body response ends in this function
let status = rsp.status();
let req_id = rsp
.headers()
.get("x-openstack-request-id")
.and_then(|x| x.to_str().ok().map(Into::into));

if http::StatusCode::NOT_FOUND.as_u16() == status {
return Self::OpenStack {
status,
uri: uri.unwrap_or(Uri::from_static("/")),
msg: String::new(),
req_id,
};
};

Self::OpenStackService {
status,
uri: uri.unwrap_or(Uri::from_static("/")),
data: String::from_utf8_lossy(body).into(),
req_id,
}
}

/// Process server error response with Json body
pub(crate) fn from_openstack(
uri: Option<Uri>,
status: http::StatusCode,
rsp: &Response<Bytes>,
value: serde_json::Value,
) -> Self {
let status = rsp.status();
let req_id = rsp
.headers()
.get("x-openstack-request-id")
.and_then(|x| x.to_str().ok().map(Into::into));

if http::StatusCode::NOT_FOUND.as_u16() == status {
return Self::OpenStack {
status,
uri: uri.unwrap_or(Uri::from_static("/")),
msg: value.to_string(),
req_id,
};
};

Expand All @@ -208,25 +233,28 @@ where

if let Some(error_value) = error_value {
if let Some(msg) = error_value.as_str() {
// Error we know how to parse
// Error we know how to parse (string)
ApiError::OpenStack {
status,
uri: uri.unwrap_or(Uri::from_static("/")),
msg: msg.into(),
req_id,
}
} else {
// Error we do not know how to parse
// Error we do not know how to parse (perhaps an object)
ApiError::OpenStackUnrecognized {
status,
uri: uri.unwrap_or(Uri::from_static("/")),
obj: error_value.clone(),
req_id,
}
}
} else {
ApiError::OpenStackUnrecognized {
status,
uri: uri.unwrap_or(Uri::from_static("/")),
obj: value,
req_id,
}
}
}
Expand All @@ -241,7 +269,8 @@ where

#[cfg(test)]
mod tests {
use http::Uri;
use bytes::Bytes;
use http::{Response, Uri};
use serde_json::json;
use thiserror::Error;

Expand All @@ -259,13 +288,24 @@ mod tests {

let err: ApiError<MyError> = ApiError::from_openstack(
Some(Uri::from_static("http://foo.bar")),
http::StatusCode::CONFLICT,
&Response::builder()
.status(http::StatusCode::CONFLICT)
.header("x-openstack-request-id", "reqid")
.body(Bytes::from(serde_json::to_vec(&obj).unwrap()))
.unwrap(),
obj.clone(),
);
if let ApiError::OpenStack { status, uri, msg } = err {
if let ApiError::OpenStack {
status,
uri,
msg,
req_id,
} = err
{
assert_eq!(uri, Uri::from_static("http://foo.bar"));
assert_eq!(msg, "error contents");
assert_eq!(status, http::StatusCode::CONFLICT);
assert_eq!(req_id, Some("reqid".into()));
} else {
panic!("unexpected error: {err}");
}
Expand All @@ -279,13 +319,24 @@ mod tests {

let err: ApiError<MyError> = ApiError::from_openstack(
Some(Uri::from_static("http://foo.bar")),
http::StatusCode::CONFLICT,
&Response::builder()
.status(http::StatusCode::CONFLICT)
.header("x-openstack-request-id", "reqid")
.body(Bytes::from(serde_json::to_vec(&obj).unwrap()))
.unwrap(),
obj.clone(),
);
if let ApiError::OpenStack { status, uri, msg } = err {
if let ApiError::OpenStack {
status,
uri,
msg,
req_id,
} = err
{
assert_eq!(uri, Uri::from_static("http://foo.bar"));
assert_eq!(msg, "error contents");
assert_eq!(status, http::StatusCode::CONFLICT);
assert_eq!(req_id, Some("reqid".into()));
} else {
panic!("unexpected error: {err}");
}
Expand All @@ -302,13 +353,24 @@ mod tests {

let err: ApiError<MyError> = ApiError::from_openstack(
Some(Uri::from_static("http://foo.bar")),
http::StatusCode::CONFLICT,
&Response::builder()
.status(http::StatusCode::CONFLICT)
.header("x-openstack-request-id", "reqid")
.body(Bytes::from(serde_json::to_vec(&obj).unwrap()))
.unwrap(),
obj.clone(),
);
if let ApiError::OpenStackUnrecognized { status, uri, obj } = err {
if let ApiError::OpenStackUnrecognized {
status,
uri,
obj,
req_id,
} = err
{
assert_eq!(uri, Uri::from_static("http://foo.bar"));
assert_eq!(obj, err_obj);
assert_eq!(status, http::StatusCode::CONFLICT);
assert_eq!(req_id, Some("reqid".into()));
} else {
panic!("unexpected error: {err}");
}
Expand All @@ -322,13 +384,24 @@ mod tests {

let err: ApiError<MyError> = ApiError::from_openstack(
Some(Uri::from_static("http://foo.bar")),
http::StatusCode::CONFLICT,
&Response::builder()
.status(http::StatusCode::CONFLICT)
.header("x-openstack-request-id", "reqid")
.body(Bytes::from(serde_json::to_vec(&err_obj).unwrap()))
.unwrap(),
err_obj.clone(),
);
if let ApiError::OpenStackUnrecognized { status, uri, obj } = err {
if let ApiError::OpenStackUnrecognized {
status,
uri,
obj,
req_id,
} = err
{
assert_eq!(uri, Uri::from_static("http://foo.bar"));
assert_eq!(obj, err_obj);
assert_eq!(status, http::StatusCode::CONFLICT);
assert_eq!(req_id, Some("reqid".into()));
} else {
panic!("unexpected error: {err}");
}
Expand All @@ -342,13 +415,24 @@ mod tests {

let err: ApiError<MyError> = ApiError::from_openstack(
Some(Uri::from_static("http://foo.bar")),
http::StatusCode::NOT_FOUND,
&Response::builder()
.status(http::StatusCode::NOT_FOUND)
.header("x-openstack-request-id", "reqid")
.body(Bytes::from(serde_json::to_vec(&err_obj).unwrap()))
.unwrap(),
err_obj.clone(),
);
if let ApiError::OpenStack { status, uri, msg } = err {
if let ApiError::OpenStack {
status,
uri,
msg,
req_id,
} = err
{
assert_eq!(uri, Uri::from_static("http://foo.bar"));
assert_eq!(msg, err_obj.to_string());
assert_eq!(status, http::StatusCode::NOT_FOUND);
assert_eq!(req_id, Some("reqid".into()));
} else {
panic!("unexpected error: {err}");
}
Expand All @@ -363,13 +447,24 @@ mod tests {

let err: ApiError<MyError> = ApiError::from_openstack(
Some(Uri::from_static("http://foo.bar")),
http::StatusCode::CONFLICT,
&Response::builder()
.status(http::StatusCode::CONFLICT)
.header("x-openstack-request-id", "reqid")
.body(Bytes::from(serde_json::to_vec(&obj).unwrap()))
.unwrap(),
obj.clone(),
);
if let ApiError::OpenStack { status, uri, msg } = err {
if let ApiError::OpenStack {
status,
uri,
msg,
req_id,
} = err
{
assert_eq!(uri, Uri::from_static("http://foo.bar"));
assert_eq!(obj["faultstring"], msg);
assert_eq!(status, http::StatusCode::CONFLICT);
assert_eq!(req_id, Some("reqid".into()));
} else {
panic!("unexpected error: {err}");
}
Expand Down
8 changes: 4 additions & 4 deletions openstack_sdk/src/api/ignore.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ where
let v = if let Ok(v) = serde_json::from_slice(rsp.body()) {
v
} else {
return Err(ApiError::server_error(query_uri, rsp.status(), rsp.body()));
return Err(ApiError::server_error(query_uri, &rsp, rsp.body()));
};
return Err(ApiError::from_openstack(query_uri, status, v));
return Err(ApiError::from_openstack(query_uri, &rsp, v));
}

Ok(())
Expand Down Expand Up @@ -101,9 +101,9 @@ where
let v = if let Ok(v) = serde_json::from_slice(rsp.body()) {
v
} else {
return Err(ApiError::server_error(query_uri, rsp.status(), rsp.body()));
return Err(ApiError::server_error(query_uri, &rsp, rsp.body()));
};
return Err(ApiError::from_openstack(query_uri, status, v));
return Err(ApiError::from_openstack(query_uri, &rsp, v));
}

Ok(())
Expand Down
4 changes: 2 additions & 2 deletions openstack_sdk/src/api/paged.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,10 +155,10 @@ where
let mut v = if let Ok(v) = serde_json::from_slice(rsp.body()) {
v
} else {
return Err(ApiError::server_error(query_uri, status, rsp.body()));
return Err(ApiError::server_error(query_uri, &rsp, rsp.body()));
};
if !status.is_success() {
return Err(ApiError::from_openstack(query_uri, status, v));
return Err(ApiError::from_openstack(query_uri, &rsp, v));
}

if use_keyset_pagination {
Expand Down
4 changes: 2 additions & 2 deletions openstack_sdk/src/api/paged/iter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,14 +254,14 @@ where
} else {
return Err(ApiError::server_error(
Some(query::url_to_http_uri(base)),
status,
&rsp,
rsp.body(),
));
};
if !status.is_success() {
return Err(ApiError::from_openstack(
Some(query::url_to_http_uri(base)),
status,
&rsp,
v,
));
}
Expand Down
Loading
Loading