refactor: Moving from anyhow to thiserror part 1 (#6250)

### Description Part 1 of moving us away from anyhow and to thiserror. We're doing this migration so we can explicitly categorize our errors and eventually provide nicer messages via miette. This converts a lot of the auxiliary commands like login, link, logout, etc. ### Testing Instructions  Closes TURBO-1518 --------- Co-authored-by: nicholaslyang <Nicholas Yang>
vercel · Oct 24, 2023 · cde6e21 · cde6e21
1 parent d30264d
commit cde6e21
Show file tree

Hide file tree

Showing 16 changed files with 294 additions and 162 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/turborepo-auth/Cargo.toml b/crates/turborepo-auth/Cargo.toml
@@ -21,6 +21,7 @@ turborepo-api-client = { workspace = true }
 turborepo-ui.workspace = true
 turborepo-vercel-api = { workspace = true }
 turborepo-vercel-api-mock = { workspace = true }
+url = { workspace = true }
 webbrowser = { workspace = true }
 
 [dev-dependencies]

diff --git a/crates/turborepo-auth/src/auth/login.rs b/crates/turborepo-auth/src/auth/login.rs
@@ -1,6 +1,5 @@
 use std::{borrow::Cow, sync::Arc};
 
-use anyhow::{anyhow, Result};
 pub use error::Error;
 use reqwest::Url;
 use tokio::sync::OnceCell;
@@ -21,7 +20,7 @@ pub async fn login<'a>(
     existing_token: Option<&'a str>,
     login_url_configuration: &str,
     login_server: &impl LoginServer,
-) -> Result<Cow<'a, str>> {
+) -> Result<Cow<'a, str>, Error> {
     // Check if token exists first.
     if let Some(token) = existing_token {
         if let Ok(response) = api_client.get_user(token).await {
@@ -65,12 +64,13 @@ pub async fn login<'a>(
 
     spinner.finish_and_clear();
 
-    let token = token_cell
-        .get()
-        .ok_or_else(|| anyhow!("Failed to get token"))?;
+    let token = token_cell.get().ok_or(Error::FailedToGetToken)?;
 
     // TODO: make this a request to /teams endpoint instead?
-    let user_response = api_client.get_user(token.as_str()).await?;
+    let user_response = api_client
+        .get_user(token.as_str())
+        .await
+        .map_err(Error::FailedToFetchUser)?;
 
     ui::print_cli_authorized(&user_response.user.email, ui);
 
@@ -83,7 +83,7 @@ mod tests {
 
     use async_trait::async_trait;
     use reqwest::{Method, RequestBuilder, Response};
-    use turborepo_api_client::{Client, Error, Result};
+    use turborepo_api_client::Client;
     use turborepo_vercel_api::{
         CachingStatusResponse, Membership, PreflightResponse, Role, SpacesResponse, Team,
         TeamsResponse, User, UserResponse, VerifiedSsoUser,
@@ -103,7 +103,7 @@ mod tests {
             _: u16,
             _: String,
             login_token: Arc<OnceCell<String>>,
-        ) -> anyhow::Result<()> {
+        ) -> Result<(), Error> {
             self.hits.fetch_add(1, std::sync::atomic::Ordering::SeqCst);
             login_token
                 .set(turborepo_vercel_api_mock::EXPECTED_TOKEN.to_string())
@@ -144,7 +144,7 @@ mod tests {
 
     #[async_trait]
     impl Client for MockApiClient {
-        async fn get_user(&self, token: &str) -> Result<UserResponse> {
+        async fn get_user(&self, token: &str) -> turborepo_api_client::Result<UserResponse> {
             if token.is_empty() {
                 return Err(MockApiError::EmptyToken.into());
             }
@@ -159,7 +159,7 @@ mod tests {
                 },
             })
         }
-        async fn get_teams(&self, token: &str) -> Result<TeamsResponse> {
+        async fn get_teams(&self, token: &str) -> turborepo_api_client::Result<TeamsResponse> {
             if token.is_empty() {
                 return Err(MockApiError::EmptyToken.into());
             }
@@ -175,7 +175,11 @@ mod tests {
                 }],
             })
         }
-        async fn get_team(&self, _token: &str, _team_id: &str) -> Result<Option<Team>> {
+        async fn get_team(
+            &self,
+            _token: &str,
+            _team_id: &str,
+        ) -> turborepo_api_client::Result<Option<Team>> {
             unimplemented!("get_team")
         }
         fn add_ci_header(_request_builder: RequestBuilder) -> RequestBuilder {
@@ -193,13 +197,21 @@ mod tests {
             _token: &str,
             _team_id: &str,
             _team_slug: Option<&str>,
-        ) -> Result<CachingStatusResponse> {
+        ) -> turborepo_api_client::Result<CachingStatusResponse> {
             unimplemented!("get_caching_status")
         }
-        async fn get_spaces(&self, _token: &str, _team_id: Option<&str>) -> Result<SpacesResponse> {
+        async fn get_spaces(
+            &self,
+            _token: &str,
+            _team_id: Option<&str>,
+        ) -> turborepo_api_client::Result<SpacesResponse> {
             unimplemented!("get_spaces")
         }
-        async fn verify_sso_token(&self, token: &str, _: &str) -> Result<VerifiedSsoUser> {
+        async fn verify_sso_token(
+            &self,
+            token: &str,
+            _: &str,
+        ) -> turborepo_api_client::Result<VerifiedSsoUser> {
             Ok(VerifiedSsoUser {
                 token: token.to_string(),
                 team_id: Some("team_id".to_string()),
@@ -212,10 +224,10 @@ mod tests {
             _duration: u64,
             _tag: Option<&str>,
             _token: &str,
-        ) -> Result<()> {
+        ) -> turborepo_api_client::Result<()> {
             unimplemented!("put_artifact")
         }
-        async fn handle_403(_response: Response) -> Error {
+        async fn handle_403(_response: Response) -> turborepo_api_client::Error {
             unimplemented!("handle_403")
         }
         async fn fetch_artifact(
@@ -224,7 +236,7 @@ mod tests {
             _token: &str,
             _team_id: &str,
             _team_slug: Option<&str>,
-        ) -> Result<Response> {
+        ) -> turborepo_api_client::Result<Response> {
             unimplemented!("fetch_artifact")
         }
         async fn artifact_exists(
@@ -233,7 +245,7 @@ mod tests {
             _token: &str,
             _team_id: &str,
             _team_slug: Option<&str>,
-        ) -> Result<Response> {
+        ) -> turborepo_api_client::Result<Response> {
             unimplemented!("artifact_exists")
         }
         async fn get_artifact(
@@ -243,7 +255,7 @@ mod tests {
             _team_id: &str,
             _team_slug: Option<&str>,
             _method: Method,
-        ) -> Result<Response> {
+        ) -> turborepo_api_client::Result<Response> {
             unimplemented!("get_artifact")
         }
         async fn do_preflight(
@@ -252,7 +264,7 @@ mod tests {
             _request_url: &str,
             _request_method: &str,
             _request_headers: &str,
-        ) -> Result<PreflightResponse> {
+        ) -> turborepo_api_client::Result<PreflightResponse> {
             unimplemented!("do_preflight")
         }
         fn make_url(&self, endpoint: &str) -> String {

diff --git a/crates/turborepo-auth/src/auth/sso.rs b/crates/turborepo-auth/src/auth/sso.rs
@@ -1,20 +1,19 @@
 use std::{borrow::Cow, sync::Arc};
 
-use anyhow::{anyhow, Context, Result};
 use reqwest::Url;
 use tokio::sync::OnceCell;
 use tracing::warn;
 use turborepo_api_client::Client;
 use turborepo_ui::{start_spinner, BOLD, UI};
 
-use crate::{error, server, ui};
+use crate::{error, server, ui, Error};
 
 const DEFAULT_HOST_NAME: &str = "127.0.0.1";
 const DEFAULT_PORT: u16 = 9789;
 const DEFAULT_SSO_PROVIDER: &str = "SAML/OIDC Single Sign-On";
 
-fn make_token_name() -> Result<String> {
-    let host = hostname::get()?;
+fn make_token_name() -> Result<String, Error> {
+    let host = hostname::get().map_err(Error::FailedToMakeSSOTokenName)?;
 
     Ok(format!(
         "Turbo CLI on {} via {DEFAULT_SSO_PROVIDER}",
@@ -31,7 +30,7 @@ pub async fn sso_login<'a>(
     login_url_configuration: &str,
     sso_team: &str,
     login_server: &impl server::SSOLoginServer,
-) -> Result<Cow<'a, str>> {
+) -> Result<Cow<'a, str>, Error> {
     // Check if token exists first. Must be there for the user and contain the
     // sso_team passed into this function.
     if let Some(token) = existing_token {
@@ -80,14 +79,19 @@ pub async fn sso_login<'a>(
     login_server.run(DEFAULT_PORT, token_cell.clone()).await?;
     spinner.finish_and_clear();
 
-    let token = token_cell
-        .get()
-        .ok_or_else(|| anyhow!("no token auth token found"))?;
+    let token = token_cell.get().ok_or(Error::FailedToGetToken)?;
 
-    let token_name = make_token_name().context("failed to make sso token name")?;
+    let token_name = make_token_name()?;
 
-    let verified_user = api_client.verify_sso_token(token, &token_name).await?;
-    let user_response = api_client.get_user(&verified_user.token).await?;
+    let verified_user = api_client
+        .verify_sso_token(token, &token_name)
+        .await
+        .map_err(Error::FailedToValidateSSOToken)?;
+
+    let user_response = api_client
+        .get_user(&verified_user.token)
+        .await
+        .map_err(Error::FailedToFetchUser)?;
 
     ui::print_cli_authorized(&user_response.user.email, ui);
 
@@ -100,7 +104,7 @@ mod tests {
 
     use async_trait::async_trait;
     use reqwest::{Method, RequestBuilder, Response};
-    use turborepo_api_client::{Client, Error, Result};
+    use turborepo_api_client::Client;
     use turborepo_vercel_api::{
         CachingStatusResponse, Membership, PreflightResponse, Role, SpacesResponse, Team,
         TeamsResponse, User, UserResponse, VerifiedSsoUser,
@@ -151,7 +155,7 @@ mod tests {
 
     #[async_trait]
     impl Client for MockApiClient {
-        async fn get_user(&self, token: &str) -> Result<UserResponse> {
+        async fn get_user(&self, token: &str) -> turborepo_api_client::Result<UserResponse> {
             if token.is_empty() {
                 return Err(MockApiError::EmptyToken.into());
             }
@@ -166,7 +170,7 @@ mod tests {
                 },
             })
         }
-        async fn get_teams(&self, token: &str) -> Result<TeamsResponse> {
+        async fn get_teams(&self, token: &str) -> turborepo_api_client::Result<TeamsResponse> {
             if token.is_empty() {
                 return Err(MockApiError::EmptyToken.into());
             }
@@ -182,7 +186,11 @@ mod tests {
                 }],
             })
         }
-        async fn get_team(&self, _token: &str, _team_id: &str) -> Result<Option<Team>> {
+        async fn get_team(
+            &self,
+            _token: &str,
+            _team_id: &str,
+        ) -> turborepo_api_client::Result<Option<Team>> {
             unimplemented!("get_team")
         }
         fn add_ci_header(_request_builder: RequestBuilder) -> RequestBuilder {
@@ -200,13 +208,21 @@ mod tests {
             _token: &str,
             _team_id: &str,
             _team_slug: Option<&str>,
-        ) -> Result<CachingStatusResponse> {
+        ) -> turborepo_api_client::Result<CachingStatusResponse> {
             unimplemented!("get_caching_status")
         }
-        async fn get_spaces(&self, _token: &str, _team_id: Option<&str>) -> Result<SpacesResponse> {
+        async fn get_spaces(
+            &self,
+            _token: &str,
+            _team_id: Option<&str>,
+        ) -> turborepo_api_client::Result<SpacesResponse> {
             unimplemented!("get_spaces")
         }
-        async fn verify_sso_token(&self, token: &str, _: &str) -> Result<VerifiedSsoUser> {
+        async fn verify_sso_token(
+            &self,
+            token: &str,
+            _: &str,
+        ) -> turborepo_api_client::Result<VerifiedSsoUser> {
             Ok(VerifiedSsoUser {
                 token: token.to_string(),
                 team_id: Some("team_id".to_string()),
@@ -219,10 +235,10 @@ mod tests {
             _duration: u64,
             _tag: Option<&str>,
             _token: &str,
-        ) -> Result<()> {
+        ) -> turborepo_api_client::Result<()> {
             unimplemented!("put_artifact")
         }
-        async fn handle_403(_response: Response) -> Error {
+        async fn handle_403(_response: Response) -> turborepo_api_client::Error {
             unimplemented!("handle_403")
         }
         async fn fetch_artifact(
@@ -231,7 +247,7 @@ mod tests {
             _token: &str,
             _team_id: &str,
             _team_slug: Option<&str>,
-        ) -> Result<Response> {
+        ) -> turborepo_api_client::Result<Response> {
             unimplemented!("fetch_artifact")
         }
         async fn artifact_exists(
@@ -240,7 +256,7 @@ mod tests {
             _token: &str,
             _team_id: &str,
             _team_slug: Option<&str>,
-        ) -> Result<Response> {
+        ) -> turborepo_api_client::Result<Response> {
             unimplemented!("artifact_exists")
         }
         async fn get_artifact(
@@ -250,7 +266,7 @@ mod tests {
             _team_id: &str,
             _team_slug: Option<&str>,
             _method: Method,
-        ) -> Result<Response> {
+        ) -> turborepo_api_client::Result<Response> {
             unimplemented!("get_artifact")
         }
         async fn do_preflight(
@@ -259,14 +275,15 @@ mod tests {
             _request_url: &str,
             _request_method: &str,
             _request_headers: &str,
-        ) -> Result<PreflightResponse> {
+        ) -> turborepo_api_client::Result<PreflightResponse> {
             unimplemented!("do_preflight")
         }
         fn make_url(&self, endpoint: &str) -> String {
             format!("{}{}", self.base_url, endpoint)
         }
     }
 
+    #[derive(Clone)]
     struct MockSSOLoginServer {
         hits: Arc<AtomicUsize>,
     }
@@ -277,7 +294,7 @@ mod tests {
             &self,
             _port: u16,
             verification_token: Arc<OnceCell<String>>,
-        ) -> anyhow::Result<()> {
+        ) -> Result<(), Error> {
             self.hits.fetch_add(1, std::sync::atomic::Ordering::SeqCst);
             verification_token
                 .set(EXPECTED_VERIFICATION_TOKEN.to_string())

diff --git a/crates/turborepo-auth/src/error.rs b/crates/turborepo-auth/src/error.rs
@@ -1,3 +1,5 @@
+use std::io;
+
 use thiserror::Error;
 
 #[derive(Debug, Error)]
@@ -7,4 +9,14 @@ pub enum Error {
          situations like using a `data:` URL."
     )]
     LoginUrlCannotBeABase { value: String },
+    #[error("failed to get token")]
+    FailedToGetToken,
+    #[error("failed to fetch user: {0}")]
+    FailedToFetchUser(turborepo_api_client::Error),
+    #[error("url is invalid: {0}")]
+    InvalidUrl(#[from] url::ParseError),
+    #[error("failed to validate sso token")]
+    FailedToValidateSSOToken(turborepo_api_client::Error),
+    #[error("failed to make sso token name")]
+    FailedToMakeSSOTokenName(io::Error),
 }