Upgrade guidance for error changes

[jdisanti]

This is an upgrade guide and summary of changes made in smithy-rs#1926, that will be linked in the release notes.

At a high level, errors were refactored to:

• Be either actionable or informational. Actionable errors can be matched upon, leading to different program flow. Informational errors indicate why a failure occurred, but are not intended to be matched upon.
• No longer print error sources in Display impls. A DisplayErrorContext utility has been re-exported in the types module to easily log or print the entire error source chain.
• Reliably return their cause/source in their Error::cause/Error::source impl

Additionally, a convenience was added to SdkError to make matching on the error kind easier (shown below in SdkError Changes).

Example of using DisplayErrorContext

When logging an error from the SDK, it is recommended that you either wrap the error in DisplayErrorContext, or use another error reporter library that visits the error's cause/source chain.

use my_generated_crate::types::DisplayErrorContext;

println!("Something broke in the SDK: {}", DisplayErrorContext(&err));

SdkError Changes

SdkError previously had struct variants, but those have been replaced with actual structs. This impacts matching on SdkError. Previously, you might have something like:

let result = client
	.get_object()
	.bucket(BUCKET_NAME)
	.key("some-key")
	.send()
	.await;
match result {
	Ok(_output) => { /* Do something with the output */ }
	Err(err) => match err {
		SdkError::ServiceError {
			err: ref service_err,
			..
		} => match service_err {
			GetObjectError {
				kind: GetObjectErrorKind::InvalidObjectState(value),
				..
			} => {
				println!("invalid object state: {:?}", value);
			}
			GetObjectError {
				kind: GetObjectErrorKind::NoSuchKey(_),
				..
			} => {
				println!("object didn't exist");
			}
			GetObjectError { .. } if service_err.code() == Some("SomeUnmodeledError") => {}
			_ => Err(err)?,
		},
		_ => Err(err)?,
	},
}

In the latest version, SdkError has an into_service_error() method that allows this to be simplified slightly:

let result = client
    .get_object()
    .bucket(BUCKET_NAME)
    .key("some-key")
    .send()
    .await;
match result {
    Ok(_output) => { /* Do something with the output */ }
    Err(err) => match err.into_service_error() {
        GetObjectError {
            kind: GetObjectErrorKind::InvalidObjectState(value),
            ..
        } => {
            println!("invalid object state: {:?}", value);
        }
        GetObjectError {
            kind: GetObjectErrorKind::NoSuchKey(_),
            ..
        } => {
            println!("object didn't exist");
        }
        err @ GetObjectError { .. } if err.code() == Some("SomeUnmodeledError") => {}
        err @ _ => return Err(err.into()),
    },
}

Full List of Changes

• Generated presigning::Errors are no longer matchable.
• aws_config::ecs::InvalidFullUriError is no longer matchable.
• aws_config::imds::client::ImdsError moved into aws_config::imds::client::error.
• aws_config::imds::client::InvalidEndpointMode moved into aws_config::imds::client::error.
• aws_config::imds::client::BuildError moved into aws_config::imds::client::error, and is no longer matchable.
• aws_config::imds::client::TokenError moved into aws_config::imds::client::error, and is no longer matchable.
• aws_endpoint::AwsEndpointStageError is no longer matchable.
• aws_http::auth::CredentialsStageError is no longer matchable.
• aws_http::user_agent::UserAgentStageError is no longer matchable.
• aws_sig_auth::middleware::SigningStageError is no longer matchable.
• aws_types::credentials::CredentialsError now has separate context structs on its enum variants.
• aws_sigv4::signer::SigningError is now an actual error type instead of a Box<dyn Error + Send + Sync>.
• The Unhandled variant on generated errors now has an Unhandled new type rather than a Box<dyn Error + Send + Sync + 'static> as its tuple member.
• aws_smithy_async::future::timeout::TimedOutError no longer implements Copy, Clone, Eq, and PartialEq.
• aws_smithy_checksums::Error was renamed to aws_smithy_checksums::error::UnknownChecksumAlgorithmError, and is no longer matchable.
• aws_smithy_eventstream::error::Error is no longer matchable.
• aws_smithy_http::endpoint::Error was renamed to aws_smithy_http::endpoint::error::ResolveEndpointError
• SdkError variants can no longer be directly constructed. There are now functions on SdkError to construct each individual variant.
• aws_smithy_http::byte_stream::Error was moved to aws_smithy_http::byte_stream::error::Error, and is no longer matchable.
• aws_smithy_http::endpoint::Error was renamed to aws_smithy_http::endpoint::error::ResolveEndpointError, and is no longer matchable.
• aws_smithy_http::endpoint::InvalidEndpoint were moved into aws_smithy_http::endpoint::error, and is no longer matchable.
• aws_smithy_http::event_stream::Error was renamed to aws_smithy_http::event_stream::ReceiverError.
• aws_smithy_http::operation::BuildError was renamed to aws_smithy_http::operation::error::BuildError, and is no longer matchable.
• aws_smithy_http::operation::SerializationError was renamed to aws_smithy_http::operation::error::SerializationError, and is no longer matchable.
• aws_smithy_json::deserialize::Error was renamed to aws_smithy_json::deserialize::error::DeserializeError, and is no longer matchable.
• aws_smithy_json::escape::EscapeError is no longer matchable.
• aws_smithy_types::base64::DecodeError is no longer matchable, and no longer implements Clone, Eq, and PartialEq.
• aws_smithy_types::TryFromNumberError moved to aws_smithy_types::error::TryFromNumberError, and is no longer matchable.
• aws_smithy_types::date_time::format::DateTimeParseError is no longer matchable.
• aws_smithy_types::date_time::format::DateTimeFormatError is no longer matchable.
• aws_smithy_types::primitive::PrimitiveParseError no longer implements Eq, PartialEq, and Clone.
• aws_smithy_types::retry::RetryModeParseErr was renamed to RetryModeParseError
• aws_smithy_types::retry::RetryConfigErr and aws_smithy_types::timeout::error::ConfigError were deleted since they were no longer referenced.
• aws_smithy_types_convert::date_time::Error is no longer matchable.
• aws_smithy_xml::decode::XmlError was renamed to XmlDecodeError, and is no longer matchable.
• aws_smithy_xml::encode::Error was renamed to XmlEncodeError.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.