fix: various fixes and corrections (#1729)

* nit: ignore private folder

* fix: docs link

* feat: templates logos

* fix: improved deployer error message in multi binary builds

* chore: mark project list paging as deprecated

* fix: admin project names, project name severity level

Author: jonaro00

.gitignore

@@ -43,3 +43,5 @@ yarn.lock
 *.wasm
 *.sqlite*
 .envrc
+
+/private

Cargo.lock

@@ -6,6 +6,7 @@ publish = false
 
 [dependencies]
 shuttle-common = { workspace = true, features = ["models"] }
+shuttle-backends = { workspace = true }
 
 anyhow = { workspace = true }
 bytes = { workspace = true }

admin/Cargo.toml

@@ -4,10 +4,7 @@ use shuttle_admin::{
     client::Client,
     config::get_api_key,
 };
-use std::{
-    collections::{hash_map::RandomState, HashMap},
-    fmt::Write,
-};
+use shuttle_backends::project_name::ProjectName;
 use tracing::trace;
 
 #[tokio::main]
@@ -21,131 +18,63 @@ async fn main() {
     let api_key = get_api_key();
     let client = Client::new(args.api_url.clone(), api_key);
 
-    let res = match args.command {
-        Command::Revive => client.revive().await.expect("revive to succeed"),
-        Command::Destroy => client.destroy().await.expect("destroy to succeed"),
+    match args.command {
+        Command::Revive => {
+            let s = client.revive().await.expect("revive to succeed");
+            println!("{s}");
+        }
+        Command::Destroy => {
+            let s = client.destroy().await.expect("destroy to succeed");
+            println!("{s}");
+        }
         Command::Acme(AcmeCommand::CreateAccount { email, acme_server }) => {
             let account = client
                 .acme_account_create(&email, acme_server)
                 .await
                 .expect("to create ACME account");
 
-            let mut res = String::new();
-            writeln!(res, "Details of ACME account are as follow. Keep this safe as it will be needed to create certificates in the future").unwrap();
-            writeln!(res, "{}", serde_json::to_string_pretty(&account).unwrap()).unwrap();
-
-            res
+            println!("Details of ACME account are as follow. Keep this safe as it will be needed to create certificates in the future");
+            println!("{}", serde_json::to_string_pretty(&account).unwrap());
         }
         Command::Acme(AcmeCommand::Request {
             fqdn,
             project,
             credentials,
-        }) => client
-            .acme_request_certificate(&fqdn, &project, &credentials)
-            .await
-            .expect("to get a certificate challenge response"),
+        }) => {
+            let s = client
+                .acme_request_certificate(&fqdn, &project, &credentials)
+                .await
+                .expect("to get a certificate challenge response");
+            println!("{s}");
+        }
         Command::Acme(AcmeCommand::RenewCustomDomain {
             fqdn,
             project,
             credentials,
-        }) => client
-            .acme_renew_custom_domain_certificate(&fqdn, &project, &credentials)
-            .await
-            .expect("to get a certificate challenge response"),
-        Command::Acme(AcmeCommand::RenewGateway { credentials }) => client
-            .acme_renew_gateway_certificate(&credentials)
-            .await
-            .expect("to get a certificate challenge response"),
+        }) => {
+            let s = client
+                .acme_renew_custom_domain_certificate(&fqdn, &project, &credentials)
+                .await
+                .expect("to get a certificate challenge response");
+            println!("{s}");
+        }
+        Command::Acme(AcmeCommand::RenewGateway { credentials }) => {
+            let s = client
+                .acme_renew_gateway_certificate(&credentials)
+                .await
+                .expect("to get a certificate challenge response");
+            println!("{s}");
+        }
         Command::ProjectNames => {
             let projects = client
                 .get_projects()
                 .await
                 .expect("to get list of projects");
-
-            let projects: HashMap<String, String, RandomState> = HashMap::from_iter(
-                projects
-                    .into_iter()
-                    .map(|project| (project.project_name, project.account_name)),
-            );
-
-            let mut res = String::new();
-
-            for (project_name, account_name) in &projects {
-                let mut issues = Vec::new();
-                let cleaned_name = project_name.to_lowercase();
-
-                // Were there any uppercase characters
-                if &cleaned_name != project_name {
-                    // Since there were uppercase characters, will the new name clash with any existing projects
-                    if let Some(other_account) = projects.get(&cleaned_name) {
-                        if other_account == account_name {
-                            issues.push(
-                                "changing to lower case will clash with same owner".to_string(),
-                            );
-                        } else {
-                            issues.push(format!(
-                            "changing to lower case will clash with another owner: {other_account}"
-                        ));
-                        }
-                    }
-                }
-
-                let cleaned_underscore = cleaned_name.replace('_', "-");
-                // Were there any underscore cleanups
-                if cleaned_underscore != cleaned_name {
-                    // Since there were underscore cleanups, will the new name clash with any existing projects
-                    if let Some(other_account) = projects.get(&cleaned_underscore) {
-                        if other_account == account_name {
-                            issues
-                                .push("cleaning underscore will clash with same owner".to_string());
-                        } else {
-                            issues.push(format!(
-                            "cleaning underscore will clash with another owner: {other_account}"
-                        ));
-                        }
-                    }
-                }
-
-                let cleaned_separator_name = cleaned_underscore.trim_matches('-');
-                // Were there any dash cleanups
-                if cleaned_separator_name != cleaned_underscore {
-                    // Since there were dash cleanups, will the new name clash with any existing projects
-                    if let Some(other_account) = projects.get(cleaned_separator_name) {
-                        if other_account == account_name {
-                            issues.push("cleaning dashes will clash with same owner".to_string());
-                        } else {
-                            issues.push(format!(
-                                "cleaning dashes will clash with another owner: {other_account}"
-                            ));
-                        }
-                    }
-                }
-
-                // Are reserved words used
-                match cleaned_separator_name {
-                    "shuttleapp" | "shuttle" => issues.push("is a reserved name".to_string()),
-                    _ => {}
-                }
-
-                // Is it longer than 63 chars
-                if cleaned_separator_name.len() > 63 {
-                    issues.push("final name is too long".to_string());
-                }
-
-                // Only report of problem projects
-                if !issues.is_empty() {
-                    writeln!(res, "{project_name}")
-                        .expect("to write name of project name having issues");
-
-                    for issue in issues {
-                        writeln!(res, "\t- {issue}").expect("to write issue with project name");
-                    }
-
-                    writeln!(res).expect("to write a new line");
+            for p in projects {
+                if !ProjectName::is_valid(&p.project_name) {
+                    println!("{}", p.project_name);
                 }
             }
-
-            res
         }
         Command::Stats(StatsCommand::Load { clear }) => {
             let resp = if clear {
@@ -156,14 +85,14 @@ async fn main() {
 
             let has_capacity = if resp.has_capacity { "a" } else { "no" };
 
-            format!(
+            println!(
                 "Currently {} builds are running and there is {} capacity for new builds",
                 resp.builds_count, has_capacity
             )
         }
         Command::IdleCch => {
             client.idle_cch().await.expect("cch projects to be idled");
-            "Idled CCH projects".to_string()
+            println!("Idled CCH projects")
         }
         Command::ChangeProjectOwner {
             project_name,
@@ -173,9 +102,7 @@ async fn main() {
                 .change_project_owner(&project_name, &new_user_id)
                 .await
                 .unwrap();
-            format!("Changed project owner: {project_name} -> {new_user_id}")
+            println!("Changed project owner: {project_name} -> {new_user_id}")
         }
     };
-
-    println!("{res}");
 }

admin/src/main.rs

@@ -29,6 +29,7 @@ permit-pdp-client-rs = { git = "https://github.com/shuttle-hq/permit-pdp-client-
 portpicker = { workspace = true, optional = true }
 reqwest = { workspace = true, features = ["json"] }
 # keep locked to not accidentally invalidate someone's project name
+# higher versions have a lot more false positives
 rustrict = { version = "=0.7.12" }
 serde = { workspace = true, features = ["derive", "std"] }
 serde_json = { workspace = true }

backends/Cargo.toml

@@ -36,7 +36,7 @@ impl ProjectName {
 
         fn is_profanity_free(name: &str) -> bool {
             let (_censored, analysis) = Censor::from_str(name).censor_and_analyze();
-            !analysis.is(Type::MODERATE_OR_HIGHER)
+            !analysis.is(Type::SEVERE) // based on existing names, MODERATE_OR_HIGHER seems too strict
         }
 
         fn is_reserved(name: &str) -> bool {

backends/src/project_name.rs

@@ -211,11 +211,11 @@ pub enum ProjectCommand {
     /// List all projects belonging to the calling account
     List {
         #[arg(long, default_value = "1")]
-        /// Which page to display
+        /// (deprecated) Which page to display
         page: u32,
 
-        #[arg(long, default_value = "10")]
-        /// How many projects per page to display
+        #[arg(long, default_value = "15")]
+        /// (deprecated) How many projects per page to display
         limit: u32,
 
         #[arg(long, default_value_t = false)]

cargo-shuttle/src/args.rs

@@ -144,9 +144,7 @@ impl LocalProvisioner {
             Err(error) => {
                 error!("Got unexpected error while inspecting docker container: {error}");
                 error!(
-                    "Make sure Docker is installed and running. \
-                    If you're using Podman, view these instructions: \
-                    https://docs.rs/shuttle-runtime/latest/shuttle_runtime/#using-podman-instead-of-docker"
+                    "Make sure Docker is installed and running. For more help: https://docs.shuttle.rs/getting-started/local-run#docker-engines"
                 );
                 Err(Status::internal(error.to_string()))
             }

cargo-shuttle/src/provisioner_server.rs

@@ -7,6 +7,8 @@ use serde::{Deserialize, Serialize};
 pub struct TemplatesSchema {
     /// Version of this schema
     pub version: u32,
+    /// Mapping of tag names to logo URLs
+    pub logos: HashMap<String, String>,
     /// Very basic templates, typically Hello World
     pub starters: HashMap<String, TemplateDefinition>,
     /// Non-starter templates

common/src/templates.rs

@@ -393,7 +393,15 @@ async fn copy_executable(
     new_filename: &Uuid,
 ) -> Result<()> {
     fs::create_dir_all(to_directory).await?;
-    fs::copy(executable_path, to_directory.join(new_filename.to_string())).await?;
+    fs::copy(executable_path, to_directory.join(new_filename.to_string()))
+        .await
+        .map_err(|e| {
+            error!(
+                "Did not find built binary at {}. Make sure the wanted binary target has the same name as your crate.",
+                executable_path.display()
+            );
+            e
+        })?;
 
     Ok(())
 }