async-graphql/src/response.rs
2020-09-17 19:54:12 +08:00

146 lines
3.6 KiB
Rust

use crate::{CacheControl, Error, Result};
use serde::Serialize;
/// Query response
#[derive(Debug, Default)]
pub struct Response {
/// Data of query result
pub data: serde_json::Value,
/// Extensions result
pub extensions: Option<serde_json::Value>,
/// Cache control value
pub cache_control: CacheControl,
/// Error
pub error: Option<Error>,
}
impl Response {
/// Create a new successful response with the data.
#[must_use]
pub fn new(data: impl Into<serde_json::Value>) -> Self {
Self {
data: data.into(),
..Default::default()
}
}
/// Create a response from the error.
#[must_use]
pub fn from_error(error: impl Into<Error>) -> Self {
Self {
error: Some(error.into()),
..Default::default()
}
}
/// Create a response from the result of the data and an error.
#[must_use]
pub fn from_result(result: Result<serde_json::Value>) -> Self {
match result {
Ok(data) => Self::new(data),
Err(e) => Self::from_error(e),
}
}
/// Set the extensions result of the response.
#[must_use]
pub fn extensions(self, extensions: Option<serde_json::Value>) -> Self {
Self { extensions, ..self }
}
/// Set the cache control of the response.
#[must_use]
pub fn cache_control(self, cache_control: CacheControl) -> Self {
Self {
cache_control,
..self
}
}
/// Returns `true` if the response is ok.
#[inline]
pub fn is_ok(&self) -> bool {
self.error.is_none()
}
/// Returns `true` if the response is error.
#[inline]
pub fn is_err(&self) -> bool {
self.error.is_some()
}
/// Extract the error from the response. Only if the `error` field is `None` will this return
/// `Ok`.
#[inline]
pub fn into_result(self) -> Result<Self> {
if self.is_err() {
Err(self.error.unwrap())
} else {
Ok(self)
}
}
}
impl From<Error> for Response {
fn from(err: Error) -> Self {
Self::from_error(err)
}
}
/// Response for batchable queries
#[derive(Debug, Serialize)]
#[serde(untagged)]
pub enum BatchResponse {
/// Response for single queries
Single(Response),
/// Response for batch queries
Batch(Vec<Response>),
}
impl BatchResponse {
/// Get cache control value
pub fn cache_control(&self) -> CacheControl {
match self {
BatchResponse::Single(resp) => resp.cache_control,
BatchResponse::Batch(resp) => resp.iter().fold(CacheControl::default(), |acc, item| {
acc.merge(&item.cache_control)
}),
}
}
/// Returns `true` if all responses are ok.
pub fn is_ok(&self) -> bool {
match self {
BatchResponse::Single(resp) => resp.is_ok(),
BatchResponse::Batch(resp) => resp.iter().all(Response::is_ok),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_batch_response_single() {
let resp = BatchResponse::Single(Response::new(serde_json::Value::Bool(true)));
assert_eq!(serde_json::to_string(&resp).unwrap(), r#"{"data":true}"#);
}
#[test]
fn test_batch_response_batch() {
let resp = BatchResponse::Batch(vec![
Response::new(serde_json::Value::Bool(true)),
Response::new(serde_json::Value::String("1".to_string())),
]);
assert_eq!(
serde_json::to_string(&resp).unwrap(),
r#"[{"data":true},{"data":"1"}]"#
);
}
}