improved client error type

Author: Heliozoa

tmc-client/src/error.rs

@@ -13,15 +13,6 @@ type TokenError = oauth2::RequestTokenError<
 /// The main error type for tmc-client.
 #[derive(Debug, Error)]
 pub enum ClientError {
-    // Arc
-    #[error("Tried to mutate client while it was borrowed")]
-    ArcBorrowed,
-
-    // file IO
-    #[error("Failed to create temporary file")]
-    TempFile(#[source] std::io::Error),
-
-    // network
     #[error("HTTP error {status} for {url}: {error}. Obsolete client: {obsolete_client}")]
     HttpError {
         url: Url,
@@ -33,37 +24,23 @@ pub enum ClientError {
     ConnectionError(Method, Url, #[source] reqwest::Error),
     #[error("OAuth2 password exchange error")]
     Token(#[source] Box<TokenError>),
-    #[error("OAuth2 unexpected token response: {0}")]
-    TokenParse(String, #[source] serde_json::error::Error),
     #[error("Failed to parse as URL: {0}")]
     UrlParse(String, #[source] url::ParseError),
     #[error("Failed to write response")]
     HttpWriteResponse(#[source] reqwest::Error),
     #[error("Failed to deserialize response from {0} as JSON")]
     HttpJsonResponse(Url, #[source] reqwest::Error),
 
-    #[error("Failed to download some exercises")]
-    IncompleteDownloadResult {
-        downloaded: Vec<u32>,
-        failed: Vec<(u32, Box<ClientError>)>,
-    },
-
     #[error("Already authenticated")]
     AlreadyAuthenticated,
     #[error("Authentication required")]
-    NotLoggedIn,
-    #[error("Failed to find cache directory")]
-    CacheDir,
-    #[error("No values found in exercise details map returned by server")]
-    MissingDetailsValue,
-    #[error("List of exercises given was empty")]
-    NoExercisesGiven,
+    NotAuthenticated,
 
     #[error(transparent)]
     SystemTime(#[from] std::time::SystemTimeError),
     #[error(transparent)]
     WalkDir(#[from] walkdir::Error),
-    #[error("File IO error")]
+    #[error(transparent)]
     FileError(#[from] FileError),
     #[error(transparent)]
     Plugin(#[from] tmc_langs_plugins::PluginError),

tmc-client/src/response.rs

@@ -247,6 +247,11 @@ pub struct ExerciseDetails {
 }
 
 /// get /api/v8/core/exercises/details
+#[derive(Debug, Deserialize)]
+pub(crate) struct ExercisesDetailsWrapper {
+    pub exercises: Vec<ExercisesDetails>,
+}
+
 #[derive(Debug, Deserialize, Serialize, JsonSchema)]
 pub struct ExercisesDetails {
     pub id: u32,

tmc-client/src/tmc_client.rs

@@ -59,7 +59,7 @@ impl TmcClient {
         if self.0.token.is_some() {
             Ok(())
         } else {
-            Err(ClientError::NotLoggedIn)
+            Err(ClientError::NotAuthenticated)
         }
     }
 

tmc-client/src/tmc_client/api_v8.rs

@@ -819,13 +819,8 @@ pub mod core {
                 .join(","),
         );
 
-        // returns map with result in key "exercises"
-        let res: HashMap<String, Vec<ExercisesDetails>> = get_json(client, url, &[exercise_ids])?;
-        if let Some((_, val)) = res.into_iter().next() {
-            // just return whatever value is found first
-            return Ok(val);
-        }
-        Err(ClientError::MissingDetailsValue)
+        let res: ExercisesDetailsWrapper = get_json(client, url, &[exercise_ids])?;
+        Ok(res.exercises)
     }
 
     /// get /api/v8/core/exercises/{exercise_id}/solution/download

tmc-langs-cli/src/lib.rs

@@ -142,7 +142,7 @@ fn solve_error_kind(e: &anyhow::Error) -> Kind {
                     return Kind::NotLoggedIn;
                 }
             }
-            Some(ClientError::NotLoggedIn) => {
+            Some(ClientError::NotAuthenticated) => {
                 return Kind::NotLoggedIn;
             }
             Some(ClientError::ConnectionError(..)) => {