[cli] Better error message when a sui config folder exists without genesis metadata #19487
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 3 Skipped Deployments
|
| @@ -631,7 +631,7 @@ async fn start( | |||
| swarm_builder = swarm_builder.with_epoch_duration_ms(epoch_duration_ms); | |||
| } else { | |||
| if config.is_none() && !sui_config_dir()?.join(SUI_NETWORK_CONFIG).exists() { | |||
| genesis(None, None, None, false, epoch_duration_ms, None, false).await?; | |||
| genesis(None, None, None, false, epoch_duration_ms, None, false).await.map_err(|_| anyhow!("Cannot run genesis with non-empty Sui config directory: {}.\n\nIf you are trying to run a local network without persisting the data (so a new genesis that is randomly generated and will not be saved once the network is shut down), use --force-regenesis flag.\nIf you are trying to persist the network data and start from a new genesis, use sui genesis --help to see how to generate a new genesis.", sui_config_dir().unwrap().display()))?; | |||
There was a problem hiding this comment.
What's the error message this used to produce? Usually it's better to use context(...) to add extra information to the existing error message rather than entirely replace it, but maybe the existing error message doesn't help here.
There was a problem hiding this comment.
The error message that would show is the one for genesis command. The issue is that genesis command has some extra flags (e.g., --force), which we should not add here, so when that error message gets propagated here it does not make sense.
I think it's better to provide a specific error message here given this situation.
For some reason that I do not know, I've never been a fan of context 😅
There was a problem hiding this comment.
I think in a CLI setting it may not be great, it tends to work pretty well for errors coming from a service, where you can want to share a logical "call stack".
Description
Improves the error message when running
sui startwhen a sui config folder exists without genesis metadata.Test plan
Existing tests.
Release notes
Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.
For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.
sui startwhen a sui config folder exists without genesis metadata.