feat: support for canister ID migration #4423
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
viviveevee
reviewed
Dec 15, 2025
Comment on lines
37
to
91
| impl fmt::Display for ValidationError { | ||
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| match self { | ||
| ValidationError::MigrationsDisabled(Reserved) => { | ||
| write!(f, "Canister migrations are disabled at the moment.") | ||
| } | ||
| ValidationError::RateLimited(Reserved) => write!( | ||
| f, | ||
| "Canister migration has been rate-limited. Try again later." | ||
| ), | ||
| ValidationError::ValidationInProgress { canister } => write!( | ||
| f, | ||
| "Validation for canister {canister} is already in progress." | ||
| ), | ||
| ValidationError::MigrationInProgress { canister } => write!( | ||
| f, | ||
| "Canister migration for canister {canister} is already in progress." | ||
| ), | ||
| ValidationError::CanisterNotFound { canister } => { | ||
| write!(f, "The canister {canister} does not exist.") | ||
| } | ||
| ValidationError::SameSubnet(Reserved) => { | ||
| write!(f, "Both canisters are on the same subnet.") | ||
| } | ||
| ValidationError::CallerNotController { canister } => write!( | ||
| f, | ||
| "The canister {canister} is not controlled by the calling identity." | ||
| ), | ||
| ValidationError::NotController { canister } => write!( | ||
| f, | ||
| "The NNS canister sbzkb-zqaaa-aaaaa-aaaiq-cai is not a controller of canister {canister}." | ||
| ), | ||
| ValidationError::MigratedNotStopped(Reserved) => { | ||
| write!(f, "The migrated canister is not stopped.") | ||
| } | ||
| ValidationError::MigratedNotReady(Reserved) => write!( | ||
| f, | ||
| "The migrated canister is not ready for migration. Try again later." | ||
| ), | ||
| ValidationError::ReplacedNotStopped(Reserved) => { | ||
| write!(f, "The replaced canister is not stopped.") | ||
| } | ||
| ValidationError::ReplacedHasSnapshots(Reserved) => { | ||
| write!(f, "The replaced canister has snapshots.") | ||
| } | ||
| ValidationError::MigratedInsufficientCycles(Reserved) => write!( | ||
| f, | ||
| "The migrated canister does not have enough cycles for canister migration. Top up the migrated canister with the required amount of cycles." | ||
| ), | ||
| ValidationError::CallFailed { reason } => { | ||
| write!(f, "Internal IC error: a call failed due to {reason}") | ||
| } | ||
| } | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
We usually do this with thiserror, e.g. like here: https://github.com/dfinity/sdk/blob/master/src/canisters/frontend/ic-asset/src/error/create_chunk.rs
Contributor
Author
There was a problem hiding this comment.
Thanks for the pointer! I refactored the code into using thiserror, but still wonder if the following code
let (result,): (Result<(), Option<ValidationError>>,) = canister
.update(MIGRATE_CANISTER_METHOD)
.with_arg(arg)
.build()
.await?;
match result {
Ok(()) => Ok(()),
Err(None) => Err(anyhow::anyhow!("Validation failed with an unknown error.")),
Err(Some(err)) => Err(anyhow::anyhow!("Validation failed: {err}")),
}
dealing with the ValidationError is fine or should somehow avoid the "manual" anyhow::anyhow!("Validation failed: {err}")?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR implements support for canister ID migration in dfx: Canister ID migration can be performed using
dfx canister migrate-idand its status can be checked out usingdfx canister migration-status.How Has This Been Tested?
An end-to-end test is introduced in this PR.
Checklist: