feat(api-client, cargo-shuttle): json output mode (#2064)

* feat(api-client): wrapper for inner type and raw json

* feat(cargo-shuttle): json output mode for commands where it makes sense.

breaking: generate output-file arg name

* clippy

* yeet

* nit

Author: jonaro00

admin/src/client.rs

@@ -1,6 +1,9 @@
 use anyhow::Result;
 use serde_json::{json, Value};
-use shuttle_api_client::{util::ToBodyContent, ShuttleApiClient};
+use shuttle_api_client::{
+    util::{ParsedJson, ToBodyContent},
+    ShuttleApiClient,
+};
 use shuttle_common::models::{
     project::{ProjectResponse, ProjectUpdateRequest},
     team::AddTeamMemberRequest,
@@ -18,11 +21,13 @@ impl Client {
         }
     }
 
-    pub async fn get_old_certificates(&self) -> Result<Vec<(String, String, Option<String>)>> {
+    pub async fn get_old_certificates(
+        &self,
+    ) -> Result<ParsedJson<Vec<(String, String, Option<String>)>>> {
         self.inner.get_json("/admin/certificates").await
     }
 
-    pub async fn renew_certificate(&self, cert_id: &str) -> Result<String> {
+    pub async fn renew_certificate(&self, cert_id: &str) -> Result<ParsedJson<String>> {
         self.inner
             .put_json(
                 format!("/admin/certificates/renew/{cert_id}"),
@@ -35,7 +40,7 @@ impl Client {
         &self,
         project_id: &str,
         config: serde_json::Value,
-    ) -> Result<ProjectResponse> {
+    ) -> Result<ParsedJson<ProjectResponse>> {
         self.inner
             .put_json(
                 format!("/projects/{project_id}"),
@@ -47,13 +52,13 @@ impl Client {
             .await
     }
 
-    pub async fn get_project_config(&self, project_id: &str) -> Result<Value> {
+    pub async fn get_project_config(&self, project_id: &str) -> Result<ParsedJson<Value>> {
         self.inner
             .get_json(format!("/admin/projects/{project_id}/config"))
             .await
     }
 
-    pub async fn upgrade_project_to_lb(&self, project_id: &str) -> Result<Value> {
+    pub async fn upgrade_project_to_lb(&self, project_id: &str) -> Result<ParsedJson<Value>> {
         self.inner
             .put_json(
                 format!("/admin/projects/{project_id}/config"),
@@ -66,7 +71,7 @@ impl Client {
         &self,
         project_id: &str,
         update_config: &Value,
-    ) -> Result<Value> {
+    ) -> Result<ParsedJson<Value>> {
         self.inner
             .put_json(
                 format!("/admin/projects/{project_id}/scale"),
@@ -79,7 +84,7 @@ impl Client {
         &self,
         project_id: &str,
         user_id: String,
-    ) -> Result<ProjectResponse> {
+    ) -> Result<ParsedJson<ProjectResponse>> {
         self.inner
             .put_json(
                 format!("/projects/{project_id}"),
@@ -91,7 +96,11 @@ impl Client {
             .await
     }
 
-    pub async fn add_team_member(&self, team_user_id: &str, user_id: String) -> Result<String> {
+    pub async fn add_team_member(
+        &self,
+        team_user_id: &str,
+        user_id: String,
+    ) -> Result<ParsedJson<String>> {
         self.inner
             .post_json(
                 format!("/teams/{team_user_id}/members"),
@@ -126,32 +135,32 @@ impl Client {
         }
     }
 
-    pub async fn gc_free_tier(&self, days: u32) -> Result<Vec<String>> {
+    pub async fn gc_free_tier(&self, days: u32) -> Result<ParsedJson<Vec<String>>> {
         let path = format!("/admin/gc/free/{days}");
         self.inner.get_json(&path).await
     }
 
-    pub async fn gc_shuttlings(&self, minutes: u32) -> Result<Vec<String>> {
+    pub async fn gc_shuttlings(&self, minutes: u32) -> Result<ParsedJson<Vec<String>>> {
         let path = format!("/admin/gc/shuttlings/{minutes}");
         self.inner.get_json(&path).await
     }
 
-    pub async fn stop_gc_inactive_project(&self, project_id: &str) -> Result<String> {
+    pub async fn stop_gc_inactive_project(&self, project_id: &str) -> Result<ParsedJson<String>> {
         let path = format!("/admin/gc/stop-inactive-project/{project_id}");
         self.inner.put_json(&path, Option::<()>::None).await
     }
 
-    pub async fn get_user(&self, user_id: &str) -> Result<UserResponse> {
+    pub async fn get_user(&self, user_id: &str) -> Result<ParsedJson<UserResponse>> {
         self.inner.get_json(format!("/admin/users/{user_id}")).await
     }
 
-    pub async fn get_user_everything(&self, query: &str) -> Result<Value> {
+    pub async fn get_user_everything(&self, query: &str) -> Result<ParsedJson<Value>> {
         self.inner
             .get_json_with_body("/admin/users/everything", json!(query))
             .await
     }
 
-    pub async fn delete_user(&self, user_id: &str) -> Result<String> {
+    pub async fn delete_user(&self, user_id: &str) -> Result<ParsedJson<String>> {
         self.inner
             .delete_json(format!("/admin/users/{user_id}"))
             .await
@@ -168,10 +177,11 @@ impl Client {
             .await
     }
 
-    pub async fn get_expired_protrials(&self) -> Result<Vec<String>> {
+    pub async fn get_expired_protrials(&self) -> Result<ParsedJson<Vec<String>>> {
         self.inner.get_json("/admin/users/protrial-downgrade").await
     }
-    pub async fn downgrade_protrial(&self, user_id: &str) -> Result<String> {
+
+    pub async fn downgrade_protrial(&self, user_id: &str) -> Result<ParsedJson<String>> {
         self.inner
             .put_json(
                 format!("/admin/users/protrial-downgrade/{user_id}"),
@@ -180,10 +190,10 @@ impl Client {
             .await
     }
 
-    pub async fn get_projects_for_retention_policy(&self) -> Result<Vec<String>> {
+    pub async fn get_projects_for_retention_policy(&self) -> Result<ParsedJson<Vec<String>>> {
         self.inner.get_json("/admin/log-retention").await
     }
-    pub async fn fix_retention_policy(&self, project_id: &str) -> Result<String> {
+    pub async fn fix_retention_policy(&self, project_id: &str) -> Result<ParsedJson<String>> {
         self.inner
             .put_json(
                 format!("/admin/log-retention/{project_id}"),

admin/src/lib.rs

@@ -57,7 +57,8 @@ pub async fn run(args: Args) {
             let res = client
                 .update_project_owner(&project_id, new_user_id)
                 .await
-                .unwrap();
+                .unwrap()
+                .into_inner();
             println!("{res:?}");
         }
         Command::AddUserToTeam {
@@ -67,11 +68,12 @@ pub async fn run(args: Args) {
             let res = client
                 .add_team_member(&team_user_id, user_id)
                 .await
-                .unwrap();
+                .unwrap()
+                .into_inner();
             println!("{res}");
         }
         Command::RenewCerts => {
-            let certs = client.get_old_certificates().await.unwrap();
+            let certs = client.get_old_certificates().await.unwrap().into_inner();
             eprintln!("Starting renewals of {} certs in 5 seconds...", certs.len());
             tokio::time::sleep(tokio::time::Duration::from_millis(5000)).await;
             let mut any_error = false;
@@ -135,15 +137,15 @@ pub async fn run(args: Args) {
             send_emails,
             limit,
         } => {
-            let project_ids = client.gc_free_tier(days).await.unwrap();
+            let project_ids = client.gc_free_tier(days).await.unwrap().into_inner();
             gc(client, project_ids, stop_deployments, send_emails, limit).await;
         }
         Command::GcShuttlings {
             minutes,
             stop_deployments,
             limit,
         } => {
-            let project_ids = client.gc_shuttlings(minutes).await.unwrap();
+            let project_ids = client.gc_shuttlings(minutes).await.unwrap().into_inner();
             gc(client, project_ids, stop_deployments, false, limit).await;
         }
         Command::DeleteUser { user_id } => {
@@ -157,11 +159,15 @@ pub async fn run(args: Args) {
             println!("Set {user_id} to {tier}");
         }
         Command::Everything { query } => {
-            let v = client.get_user_everything(&query).await.unwrap();
+            let v = client
+                .get_user_everything(&query)
+                .await
+                .unwrap()
+                .into_inner();
             println!("{}", serde_json::to_string_pretty(&v).unwrap());
         }
         Command::DowngradeProTrials => {
-            let users = client.get_expired_protrials().await.unwrap();
+            let users = client.get_expired_protrials().await.unwrap().into_inner();
             eprintln!(
                 "Starting downgrade of {} users in 5 seconds...",
                 users.len()
@@ -172,9 +178,13 @@ pub async fn run(args: Args) {
                 println!("{user_id}");
                 println!(
                     "  {:?}",
-                    client.downgrade_protrial(&user_id).await.inspect_err(|_| {
-                        any_error = true;
-                    })
+                    client
+                        .downgrade_protrial(&user_id)
+                        .await
+                        .map(|r| r.into_inner())
+                        .inspect_err(|_| {
+                            any_error = true;
+                        })
                 );
                 // prevent api rate limiting
                 tokio::time::sleep(tokio::time::Duration::from_millis(1000)).await;
@@ -184,16 +194,24 @@ pub async fn run(args: Args) {
             }
         }
         Command::FixRetentionPolicies => {
-            let projects = client.get_projects_for_retention_policy().await.unwrap();
+            let projects = client
+                .get_projects_for_retention_policy()
+                .await
+                .unwrap()
+                .into_inner();
             eprintln!("Starting fix of {} log retention policies", projects.len());
             let mut any_error = false;
             for pid in projects {
                 println!("{pid}");
                 println!(
                     "  {:?}",
-                    client.fix_retention_policy(&pid).await.inspect_err(|_| {
-                        any_error = true;
-                    })
+                    client
+                        .fix_retention_policy(&pid)
+                        .await
+                        .map(|r| r.into_inner())
+                        .inspect_err(|_| {
+                            any_error = true;
+                        })
                 );
                 // prevent api rate limiting
                 tokio::time::sleep(tokio::time::Duration::from_millis(1000)).await;
@@ -230,9 +248,16 @@ async fn gc(
     for pid in project_ids {
         println!("{pid}");
         let call = if send_email {
-            client.stop_gc_inactive_project(&pid).await
+            client
+                .stop_gc_inactive_project(&pid)
+                .await
+                .map(|r| r.into_inner())
         } else {
-            client.inner.stop_service(&pid).await
+            client
+                .inner
+                .stop_service(&pid)
+                .await
+                .map(|r| r.into_inner())
         };
         println!(
             "  {:?}",