Skip to content

feat(cargo-shuttle): maintain project id when deleting/creating project #2098

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat(cargo-shuttle): maintain project id when deleting/creating project #2098

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bf2d2e8
feat: remove id from local config after deleting project
iksuddle Aug 9, 2025
666af3d
feat: update project id after creation
iksuddle Aug 9, 2025
2723b17
fix: update id in local config if in rust project
iksuddle Sep 10, 2025
1ca0a06
fix: delete internal config id if equal to context id
iksuddle Sep 13, 2025
b42e609
fix: don't panic if config file not found
iksuddle Sep 13, 2025
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
5 changes: 5 additions & 0 deletions cargo-shuttle/src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,11 @@ impl RequestContext {
InternalProjectConfig { id: Some(id) };
}

pub fn remove_project_id(&mut self) {
*self.project_internal.as_mut().unwrap().as_mut().unwrap() =
InternalProjectConfig { id: None };
Copy link
Member

@jonaro00 jonaro00 Sep 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it's better to modify the id field in place instead of replacing the config (in case more fields are added). Same is true for set_project_id

}

pub fn save_local_internal(&mut self) -> Result<()> {
self.project_internal.as_ref().unwrap().save()?;

Expand Down
29 changes: 21 additions & 8 deletions cargo-shuttle/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ impl Shuttle {
} => self.delete_certificate(domain, yes).await,
},
Command::Project(cmd) => match cmd {
ProjectCommand::Create => self.project_create(args.project_args.name).await,
ProjectCommand::Create => self.project_create(&args.project_args).await,
ProjectCommand::Update(cmd) => match cmd {
ProjectUpdateCommand::Name { new_name } => self.project_rename(new_name).await,
},
Expand Down Expand Up @@ -1929,24 +1929,31 @@ impl Shuttle {
Ok(())
}

async fn project_create(&self, name: Option<String>) -> Result<()> {
let Some(ref name) = name else {
async fn project_create(&mut self, project_args: &ProjectArgs) -> Result<()> {
let Some(ref name) = project_args.name else {
bail!("Provide a project name with '--name <name>'");
};

self.ctx.load_local_internal_config(project_args)?;

let client = self.client.as_ref().unwrap();
let r = client.create_project(name).await?;
let (proj, raw_json) = client.create_project(name).await?.into_parts();

match self.output_mode {
OutputMode::Normal => {
let project = r.into_inner();
println!("Created project '{}' with id {}", project.name, project.id);
println!("Created project '{}' with id {}", proj.name, proj.id);
}
OutputMode::Json => {
println!("{}", r.raw_json);
println!("{}", raw_json);
}
}

// Update the local internal config file if we are in a Rust project
if project_args.workspace_path().is_ok() {
self.ctx.set_project_id(proj.id);
self.ctx.save_local_internal()?;
}

Ok(())
}

Expand Down Expand Up @@ -2028,7 +2035,7 @@ impl Shuttle {
Ok(())
}

async fn project_delete(&self, no_confirm: bool) -> Result<()> {
async fn project_delete(&mut self, no_confirm: bool) -> Result<()> {
let client = self.client.as_ref().unwrap();
let pid = self.ctx.project_id();

Expand Down Expand Up @@ -2064,6 +2071,12 @@ impl Shuttle {

let res = client.delete_project(pid).await?.into_inner();

// todo
// if --id is provided, then we don't want to clear the id in the config file
// also should only happen if the file exists
self.ctx.remove_project_id();
self.ctx.save_local_internal()?;
Copy link
Member

@jonaro00 jonaro00 Sep 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If a --id different from the id in the config file is provided, we don't want to clear the id in the config file.

Copy link
Member

@jonaro00 jonaro00 Sep 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@iksuddle Your comment about return type on load_project_id seems to have disappeared for me... Here's my reply anyways:
Only knowing where the loaded id came from is not enough to know if an explicit --id arg is different from the one in the local_internal config file, so it seems like we need to know what was provided in both places.
Maybe adding a self.ctx.linked_project_id() -> Option<&str> (returning the id loaded from the file, if exists) and comparing it to the self.ctx.project_id() (the "resolved" id) will work?

The note about only doing it when the file exists is also valid. The method above could be used to know if the file exists, since the id is the only field in there. It could also be generalised to something like self.ctx.local_internal_exists() -> bool.

Copy link
Author

@iksuddle iksuddle Sep 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I deleted that comment when I realized it wouldn't work.

There seems to be some discrepancy between using --id vs --name.

Currently, if you run shuttle project delete --id 123 in a directory that is not a rust project, you get the error Failed to find a Rust project in this directory ... due to calling project_args.workspace_path() at the top of load_local_internal_config(). The error comes from cargo metadata. So you can't actually delete a project unless you're in a crate.

I'm not sure if this is the desired behavior, but using --name instead doesn't cause this error and results in Project with name '123' not found in your project list.

To be honest, I'm not sure why they are different, since in both load_local_internal_config and get_local_config have workspace_path().unwrap_or(...).

Also I was wondering what exactly should happen? Should both --id and --name delete projects, or neither, or just --name?

Copy link
Author

@iksuddle iksuddle Sep 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additionally, I believe project_create would need ctx.project to be Some (by calling load_project_id) so that the config file can be created/updated. This means adding it to the match for commands that require load_project_id.

Edit:
After looking into it some more I realized there's more to consider since the load_project_id function only creates a project for the deploy command, and it would be weird to create a project twice. So I guess we could either set ctx.project before calling save_local_internal in project_create, or change the way create_or_update_ignore_file works.


println!("{res}");

Ok(())
Expand Down