dropbox-sdk 0.1.0

// Copyright (c) 2019 Dropbox, Inc.

use std::fmt::Debug;
use std::marker::PhantomData;
use crate::{Error, ErrorKind, ResultExt};
use crate::client_trait::*;
use serde::de::{self, Deserialize, DeserializeOwned, Deserializer, MapAccess, Visitor};
use serde::ser::Serialize;
use serde_json;

// When Dropbox returns an error with HTTP 409, it uses an implicit JSON object with the following
// structure, which contains the acutal error as a field.
#[derive(Debug)]
struct TopLevelError<T> {
    pub error_summary: String,
    pub user_message: Option<String>,
    pub error: T,
}

impl<'de, T: DeserializeOwned> Deserialize<'de> for TopLevelError<T> {
    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        struct StructVisitor<T> {
            phantom: PhantomData<T>,
        }
        impl<'de, T: DeserializeOwned> Visitor<'de> for StructVisitor<T> {
            type Value = TopLevelError<T>;
            fn expecting(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
                f.write_str("a top-level error struct")
            }
            fn visit_map<V: MapAccess<'de>>(self, mut map: V) -> Result<Self::Value, V::Error> {
                let mut error_summary = None;
                let mut user_message = None;
                let mut error = None;
                while let Some(key) = map.next_key()? {
                    match key {
                        "error_summary" => {
                            if error_summary.is_some() {
                                return Err(de::Error::duplicate_field("error_summary"));
                            }
                            error_summary = Some(map.next_value()?);
                        }
                        "user_message" => {
                            if user_message.is_some() {
                                return Err(de::Error::duplicate_field("user_message"));
                            }
                            user_message = Some(map.next_value()?);
                        }
                        "error" => {
                            if error.is_some() {
                                return Err(de::Error::duplicate_field("error"));
                            }
                            error = Some(map.next_value()?);
                        }
                        _ => return Err(de::Error::unknown_field(key, FIELDS))
                    }
                }
                Ok(TopLevelError {
                    error_summary: error_summary.ok_or_else(|| de::Error::missing_field("error_summary"))?,
                    user_message,
                    error: error.ok_or_else(|| de::Error::missing_field("error"))?,
                })
            }
        }
        const FIELDS: &[&str] = &["error_summary", "user_message", "error"];
        deserializer.deserialize_struct("<top level error>", FIELDS, StructVisitor { phantom: PhantomData })
    }
}

/// Does the request and returns a two-level result. The outer result has an error if something
/// went horribly wrong (I/O errors, parse errors, server 500 errors, etc.). The inner result has
/// an error if the server returned one for the request, otherwise it has the deserialized JSON
/// response and the body stream (if any).
#[allow(clippy::too_many_arguments)]
pub fn request_with_body<T: DeserializeOwned, E: DeserializeOwned + Debug, P: Serialize>(
    client: &dyn HttpClient,
    endpoint: Endpoint,
    style: Style,
    function: &str,
    params: &P,
    body: Option<&[u8]>,
    range_start: Option<u64>,
    range_end: Option<u64>,
) -> super::Result<Result<HttpRequestResult<T>, E>> {
    let params_json = serde_json::to_string(params)?;
    let result = client.request(endpoint, style, function, params_json, body, range_start, range_end);
    match result {
        Ok(HttpRequestResultRaw { result_json, content_length, body }) => {
            debug!("json: {}", result_json);
            let result_value: T = serde_json::from_str(&result_json)?;
            Ok(Ok(HttpRequestResult {
                result: result_value,
                content_length,
                body,
            }))
        },
        Err(e) => {
            let innards = if let Error(ErrorKind::GeneralHttpError(
                    ref code, ref status, ref response), _) = e {
                Some((*code, status.clone(), response.clone()))
            } else {
                None
            };

            // Try to turn the error into a more specific one.
            if let Some((code, status, response)) = innards {
                error!("HTTP {} {}: {}", code, status, response);
                return match code {
                    400 => {
                        Err(e).chain_err(|| ErrorKind::BadRequest(response))
                    },
                    401 => {
                        Err(e).chain_err(|| ErrorKind::InvalidToken(response))
                    },
                    409 => {
                        // Response should be JSON-deseraializable into the strongly-typed
                        // error specified by type parameter E.
                        match serde_json::from_str::<TopLevelError<E>>(&response) {
                            Ok(deserialized) => {
                                error!("API error: {:?}", deserialized);
                                Ok(Err(deserialized.error))
                            },
                            Err(de_error) => {
                                error!("Failed to deserialize JSON from API error: {}", de_error);
                                Err(e).chain_err(|| ErrorKind::Json(de_error))
                            }
                        }
                    },
                    429 => {
                        Err(e).chain_err(|| ErrorKind::RateLimited(response))
                    },
                    500 ..= 599 => {
                        Err(e).chain_err(|| ErrorKind::ServerError(response))
                    },
                    _ => {
                        Err(e)
                    }
                }
            } else if let Error(ErrorKind::Json(ref json_err), _) = e {
                error!("JSON deserialization error: {}", json_err);
            } else {
                error!("HTTP request error: {}", e);
            }
            Err(e)
        }
    }
}

pub fn request<T: DeserializeOwned, E: DeserializeOwned + Debug, P: Serialize>(
    client: &dyn HttpClient,
    endpoint: Endpoint,
    style: Style,
    function: &str,
    params: &P,
    body: Option<&[u8]>,
) -> super::Result<Result<T, E>> {
    request_with_body(client, endpoint, style, function, params, body, None, None)
        .map(|result| result.map(|HttpRequestResult { result, .. }| result))
}