Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(cargo-shuttle): ability to force a name to be used in init #1410

Merged
merged 9 commits into from
Nov 22, 2023
Merged

feat(cargo-shuttle): ability to force a name to be used in init #1410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
5e21721
feat(cargo-shuttle): ability to force a name to be used in init
jonaro00 Nov 21, 2023
6d757cd
fix: use forced name in init tests
jonaro00 Nov 21, 2023
7774db0
period
jonaro00 Nov 21, 2023
a6763ec
clippy
jonaro00 Nov 21, 2023
a52b6e6
nit: derive default on some args
jonaro00 Nov 22, 2023
de6c31d
fix: repeat input instead of --force
jonaro00 Nov 22, 2023
974af63
fix: refactorings + fix path confirmation bug
jonaro00 Nov 22, 2023
bfee32b
nit: refactor
jonaro00 Nov 22, 2023
831f4d5
nit: variable
jonaro00 Nov 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 10 additions & 17 deletions cargo-shuttle/src/args.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ pub struct ProjectStartArgs {
pub idle_minutes: u64,
}

#[derive(Parser, Clone, Debug)]
#[derive(Parser, Clone, Debug, Default)]
pub struct LoginArgs {
/// API key for the Shuttle platform
#[arg(long)]
Expand Down Expand Up @@ -261,7 +261,7 @@ pub struct RunArgs {
pub release: bool,
}

#[derive(Parser, Clone, Debug)]
#[derive(Parser, Clone, Debug, Default)]
pub struct InitArgs {
/// Clone a starter template from Shuttle's official examples
#[arg(long, short, value_enum, conflicts_with_all = &["from", "subfolder"])]
Expand All @@ -277,6 +277,9 @@ pub struct InitArgs {
#[arg(default_value = ".", value_parser = OsStringValueParser::new().try_map(parse_init_path))]
pub path: PathBuf,

/// Don't check the project name's validity or availability and use it anyways
#[arg(long)]
pub force_name: bool,
/// Whether to start the container for this project on Shuttle, and claim the project name
#[arg(long)]
pub create_env: bool,
Expand Down Expand Up @@ -398,9 +401,7 @@ mod tests {
template: Some(InitTemplateArg::Tower),
from: None,
subfolder: None,
create_env: false,
login_args: LoginArgs { api_key: None },
path: PathBuf::new(),
..Default::default()
};
assert_eq!(
init_args.git_template().unwrap(),
Expand All @@ -415,9 +416,7 @@ mod tests {
template: Some(InitTemplateArg::Axum),
from: None,
subfolder: None,
create_env: false,
login_args: LoginArgs { api_key: None },
path: PathBuf::new(),
..Default::default()
};
assert_eq!(
init_args.git_template().unwrap(),
Expand All @@ -432,9 +431,7 @@ mod tests {
template: Some(InitTemplateArg::None),
from: None,
subfolder: None,
create_env: false,
login_args: LoginArgs { api_key: None },
path: PathBuf::new(),
..Default::default()
};
assert_eq!(
init_args.git_template().unwrap(),
Expand All @@ -449,9 +446,7 @@ mod tests {
template: None,
from: Some("https://github.com/some/repo".into()),
subfolder: Some("some/path".into()),
create_env: false,
login_args: LoginArgs { api_key: None },
path: PathBuf::new(),
..Default::default()
};
assert_eq!(
init_args.git_template().unwrap(),
Expand All @@ -466,9 +461,7 @@ mod tests {
template: None,
from: None,
subfolder: None,
create_env: false,
login_args: LoginArgs { api_key: None },
path: PathBuf::new(),
..Default::default()
};
assert_eq!(init_args.git_template().unwrap(), None);
}
Expand Down
141 changes: 90 additions & 51 deletions cargo-shuttle/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,14 +302,15 @@ impl Shuttle {
provided_path_to_init: bool,
) -> Result<CommandOutcome> {
// Turns the template or git args (if present) to a repo+folder.
let git_templates = args.git_template()?;
let git_template = args.git_template()?;

let unauthorized = self.ctx.api_key().is_err() && args.login_args.api_key.is_none();

let interactive = project_args.name.is_none()
|| git_templates.is_none()
|| !provided_path_to_init
|| unauthorized;
let needs_name = project_args.name.is_none();
let needs_template = git_template.is_none();
let needs_path = !provided_path_to_init;
let needs_login = unauthorized;
let interactive = needs_name || needs_template || needs_path || needs_login;

let theme = ColorfulTheme::default();

Expand All @@ -318,9 +319,9 @@ impl Shuttle {
let login_args = LoginArgs {
api_key: Some(api_key.as_ref().to_string()),
};

// TODO: this re-applies an already loaded API key
self.login(login_args).await?;
} else if interactive {
} else if needs_login {
println!("First, let's log in to your Shuttle account.");
self.login(args.login_args.clone()).await?;
println!();
Expand All @@ -330,54 +331,55 @@ impl Shuttle {
bail!("Tried to login to create a Shuttle environment, but no API key was set.")
}

// 2. Ask for project name
if project_args.name.is_none() {
// 2. Ask for project name or validate the given one
if needs_name {
printdoc! {"
What do you want to name your project?
It will be hosted at ${{project_name}}.shuttleapp.rs, so choose something unique!
"
};
let client = self.client.as_ref().unwrap();
loop {
// not using validate_with due to being blocking
let p: String = Input::with_theme(&theme)
}
let mut prev_name: Option<String> = None;
loop {
// prompt if interactive
let name: String = if let Some(name) = project_args.name.clone() {
name
} else {
// not using `validate_with` due to being blocking.
Input::with_theme(&theme)
.with_prompt("Project name")
.interact()?;
match client.check_project_name(&p).await {
Ok(true) => {
println!("{} {}", "Project name already taken:".red(), p);
println!("{}", "Try a different name.".yellow());
}
Ok(false) => {
project_args.name = Some(p);
break;
}
Err(e) => {
// If API error contains message regarding format of error name, print that error and prompt again
if let Ok(api_error) = e.downcast::<ApiError>() {
// If the returned error string changes, this could break
if api_error.message.contains("Invalid project name") {
println!("{}", api_error.message.yellow());
println!("{}", "Try a different name.".yellow());
continue;
}
}
// Else, the API error was about something else.
// Ignore and keep going to not prevent the flow of the init command.
project_args.name = Some(p);
println!(
"{}",
"Failed to check if project name is available.".yellow()
);
break;
}
}
.interact()?
};
let force_name = args.force_name
|| (needs_name && prev_name.as_ref().is_some_and(|prev| prev == &name));
if force_name {
project_args.name = Some(name);
break;
}
// validate and take action based on result
if self
.check_project_name(&mut project_args, name.clone())
.await
{
// success
break;
} else if needs_name {
// try again
println!(r#"Type the same name again to use "{}" anyways."#, name);
prev_name = Some(name);
} else {
// don't continue if non-interactive
bail!(
"Invalid or unavailable project name. Use `--force-name` to use this project name anyways."
);
}
}
if needs_name {
println!();
}

// 3. Confirm the project directory
let path = if interactive {
let path = if needs_path {
let path = args
.path
.to_str()
Expand Down Expand Up @@ -410,8 +412,8 @@ impl Shuttle {
};

// 4. Ask for the framework
let template = match git_templates {
Some(git_templates) => git_templates,
let template = match git_template {
Some(git_template) => git_template,
None => {
println!(
"Shuttle works with a range of web frameworks. Which one do you want to use?"
Expand All @@ -427,11 +429,10 @@ impl Shuttle {
}
};

let serenity_idle_hint = if let Some(s) = template.subfolder.as_ref() {
s.contains("serenity") || s.contains("poise")
} else {
false
};
let serenity_idle_hint = template
.subfolder
.as_ref()
.is_some_and(|s| s.contains("serenity") || s.contains("poise"));

// 5. Initialize locally
init::generate_project(
Expand Down Expand Up @@ -511,6 +512,44 @@ impl Shuttle {
Ok(CommandOutcome::Ok)
}

/// true -> success/neutral. false -> try again.
async fn check_project_name(&self, project_args: &mut ProjectArgs, name: String) -> bool {
let client = self.client.as_ref().unwrap();
match client.check_project_name(&name).await {
Ok(true) => {
println!("{} {}", "Project name already taken:".red(), name);
println!("{}", "Try a different name.".yellow());

false
}
Ok(false) => {
project_args.name = Some(name);

true
}
Err(e) => {
// If API error contains message regarding format of error name, print that error and prompt again
if let Ok(api_error) = e.downcast::<ApiError>() {
// If the returned error string changes, this could break
if api_error.message.contains("Invalid project name") {
println!("{}", api_error.message.yellow());
println!("{}", "Try a different name.".yellow());
return false;
}
}
// Else, the API error was about something else.
// Ignore and keep going to not prevent the flow of the init command.
project_args.name = Some(name);
println!(
"{}",
"Failed to check if project name is available.".yellow()
);

true
}
}
}

pub fn load_project(&mut self, project_args: &ProjectArgs) -> Result<()> {
trace!("loading project arguments: {project_args:?}");

Expand Down
Loading