Unverified Commit acbe8ce6 authored by Russell Cohen's avatar Russell Cohen Committed by GitHub
Browse files

Clean up re-exports and improve 'BuildError' conversions (#3173) 

## Motivation and Context
- Fixes #3171 
- Fixes #3155 
- Fixes #3172 


## Description
- Add `configReExport` to make it easy and consistent to re-export types
into the config module when they are used!
- Add this for a bunch of types and clean up some (now) dead code
- Re export `BuildError`
- Enable converting from `BuildError` into `SdkError`

There are probably more places this can be used, but I'd like to keep
this change small to facilitate easy backport to 0.57.

## Testing
CI

## Checklist
<!--- If a checkbox below is not applicable, then please DELETE it
rather than leaving it unchecked -->
- [x] I have updated `CHANGELOG.next.toml` if I made changes to the
smithy-rs codegen or runtime crates
- [x] I have updated `CHANGELOG.next.toml` if I made changes to the AWS
SDK, generated SDK code, or SDK runtime crates

----

_By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice._
parent 6438a09b

CHANGELOG.next.toml

+49 −0
Original line number Diff line number Diff line
@@ -58,3 +58,52 @@ message = "Fix exclusively setting the credentials provider at operation config- 
references = ["smithy-rs#3156", "aws-sdk-rust#901"]

meta = { "breaking" = false, "tada" = false, "bug" = true }

author = "ysaito1001"



[[smithy-rs]]

message = """Enable conversion from `BuildError` into `SdkError` & `<service>::Error`. This allows customers to write the following code:

```rust

async fn do_a_thing(client: &Client) -> Result<SdkError<SomeOperationError>> {

    client.run_operation().complex_field(ComplexField::builder()

        .a("a")

        .b("b")

        .build()?

    ).send().await?;

}

```



Previously, `?` could not be used in this position.

"""

references = ["smithy-rs#3173", "smithy-rs#3171"]

meta = { "breaking" = false, "tada" = true, "bug" = false }

author = "rcoh"



[[aws-sdk-rust]]

message = """Enable conversion from `BuildError` into `SdkError` & `<service>::Error`. This allows customers to write the following code:

```rust

async fn create_table(dynamo_client: &Client) -> Result<(), SdkError<CreateTableError>> {

    dynamo_client

        .create_table()

        .table_name("test")

        .key_schema(

            KeySchemaElement::builder()

                .attribute_name("year")

                .key_type(KeyType::Hash)

                .build()?, // Previously, `?` could not be used here

        )

        .send()

        .await?;

    Ok(())

}

```



Previously, `?` could not be used in this position.

"""

references = ["smithy-rs#3173", "smithy-rs#3171"]

meta = { "breaking" = false, "tada" = true, "bug" = false }

author = "rcoh"



[[aws-sdk-rust]]

message = "ProvideCredentials and SharedCredentialsProvider are now re-exported."

references = ["smithy-rs#3173", "smithy-rs#3155"]

meta = { "breaking" = false, "tada" = false, "bug" = false }

author = "rcoh"

aws/sdk-codegen/src/main/kotlin/software/amazon/smithy/rustsdk/AwsFluentClientDecorator.kt

+0 −3
Original line number Diff line number Diff line
@@ -30,11 +30,9 @@ import software.amazon.smithy.rust.codegen.core.smithy.generators.LibRsSection 
import software.amazon.smithy.rust.codegen.core.util.serviceNameOrDefault



private class Types(runtimeConfig: RuntimeConfig) {

    private val smithyHttp = RuntimeType.smithyHttp(runtimeConfig)

    private val smithyTypes = RuntimeType.smithyTypes(runtimeConfig)



    val awsTypes = AwsRuntimeType.awsTypes(runtimeConfig)

    val connectorError = smithyHttp.resolve("result::ConnectorError")

    val retryConfig = smithyTypes.resolve("retry::RetryConfig")

    val timeoutConfig = smithyTypes.resolve("timeout::TimeoutConfig")

}
@@ -102,7 +100,6 @@ class AwsFluentClientDecorator : ClientCodegenDecorator { 
private class AwsFluentClientExtensions(private val codegenContext: ClientCodegenContext, private val types: Types) {

    private val codegenScope = arrayOf(

        "Arc" to RuntimeType.Arc,

        "ConnectorError" to types.connectorError,

        "RetryConfig" to types.retryConfig,

        "TimeoutConfig" to types.timeoutConfig,

        "aws_types" to types.awsTypes,

aws/sdk-codegen/src/main/kotlin/software/amazon/smithy/rustsdk/CredentialProviders.kt

+10 −5
Original line number Diff line number Diff line
@@ -7,6 +7,7 @@ package software.amazon.smithy.rustsdk 


import software.amazon.smithy.rust.codegen.client.smithy.ClientCodegenContext

import software.amazon.smithy.rust.codegen.client.smithy.ClientRustModule

import software.amazon.smithy.rust.codegen.client.smithy.configReexport

import software.amazon.smithy.rust.codegen.client.smithy.customize.ClientCodegenDecorator

import software.amazon.smithy.rust.codegen.client.smithy.customize.TestUtilFeature

import software.amazon.smithy.rust.codegen.client.smithy.endpoint.supportedAuthSchemes
@@ -59,11 +60,15 @@ class CredentialProviderConfig(private val codegenContext: ClientCodegenContext) 
    private val runtimeConfig = codegenContext.runtimeConfig

    private val codegenScope = arrayOf(

        *preludeScope,

        "Credentials" to AwsRuntimeType.awsCredentialTypes(runtimeConfig).resolve("Credentials"),

        "ProvideCredentials" to AwsRuntimeType.awsCredentialTypes(runtimeConfig)

        "Credentials" to configReexport(AwsRuntimeType.awsCredentialTypes(runtimeConfig).resolve("Credentials")),

        "ProvideCredentials" to configReexport(

            AwsRuntimeType.awsCredentialTypes(runtimeConfig)

                .resolve("provider::ProvideCredentials"),

        "SharedCredentialsProvider" to AwsRuntimeType.awsCredentialTypes(runtimeConfig)

        ),

        "SharedCredentialsProvider" to configReexport(

            AwsRuntimeType.awsCredentialTypes(runtimeConfig)

                .resolve("provider::SharedCredentialsProvider"),

        ),

        "SIGV4A_SCHEME_ID" to AwsRuntimeType.awsRuntime(runtimeConfig)

            .resolve("auth::sigv4a::SCHEME_ID"),

        "SIGV4_SCHEME_ID" to AwsRuntimeType.awsRuntime(runtimeConfig)

aws/sdk-codegen/src/main/kotlin/software/amazon/smithy/rustsdk/RegionDecorator.kt

+2 −11
Original line number Diff line number Diff line
@@ -11,7 +11,7 @@ import software.amazon.smithy.model.node.Node 
import software.amazon.smithy.rulesengine.aws.language.functions.AwsBuiltIns

import software.amazon.smithy.rulesengine.language.syntax.parameters.Parameter

import software.amazon.smithy.rust.codegen.client.smithy.ClientCodegenContext

import software.amazon.smithy.rust.codegen.client.smithy.ClientRustModule

import software.amazon.smithy.rust.codegen.client.smithy.configReexport

import software.amazon.smithy.rust.codegen.client.smithy.customize.ClientCodegenDecorator

import software.amazon.smithy.rust.codegen.client.smithy.endpoint.EndpointCustomization

import software.amazon.smithy.rust.codegen.client.smithy.generators.config.ConfigCustomization
@@ -22,7 +22,6 @@ import software.amazon.smithy.rust.codegen.core.rustlang.rustTemplate 
import software.amazon.smithy.rust.codegen.core.rustlang.writable

import software.amazon.smithy.rust.codegen.core.smithy.RuntimeConfig

import software.amazon.smithy.rust.codegen.core.smithy.RuntimeType.Companion.preludeScope

import software.amazon.smithy.rust.codegen.core.smithy.RustCrate

import software.amazon.smithy.rust.codegen.core.smithy.customize.AdHocCustomization

import software.amazon.smithy.rust.codegen.core.smithy.customize.adhocCustomization

import software.amazon.smithy.rust.codegen.core.util.dq
@@ -109,14 +108,6 @@ class RegionDecorator : ClientCodegenDecorator { 
        }

    }



    override fun extras(codegenContext: ClientCodegenContext, rustCrate: RustCrate) {

        if (usesRegion(codegenContext)) {

            rustCrate.withModule(ClientRustModule.config) {

                rust("pub use #T::Region;", region(codegenContext.runtimeConfig))

            }

        }

    }



    override fun endpointCustomizations(codegenContext: ClientCodegenContext): List<EndpointCustomization> {

        if (!usesRegion(codegenContext)) {

            return listOf()
@@ -157,7 +148,7 @@ class RegionProviderConfig(codegenContext: ClientCodegenContext) : ConfigCustomi 
    private val moduleUseName = codegenContext.moduleUseName()

    private val codegenScope = arrayOf(

        *preludeScope,

        "Region" to region.resolve("Region"),

        "Region" to configReexport(region.resolve("Region")),

    )



    override fun section(section: ServiceConfig) = writable {

aws/sdk/integration-tests/dynamodb/tests/build-errors.rs

0 → 100644
+41 −0
Original line number Diff line number Diff line 
/*

 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

 * SPDX-License-Identifier: Apache-2.0

 */



use aws_sdk_dynamodb::error::SdkError;

use aws_sdk_dynamodb::operation::create_table::CreateTableError;

use aws_sdk_dynamodb::types::{KeySchemaElement, KeyType};

use aws_sdk_dynamodb::Client;



#[allow(dead_code)]

async fn create_table_test(client: &Client) -> Result<(), SdkError<CreateTableError>> {

    let _just_checking_compilation = client

        .create_table()

        .table_name("test")

        .key_schema(

            KeySchemaElement::builder()

                .attribute_name("year")

                .key_type(KeyType::Hash)

                .build()?,

        )

        .send()

        .await;

    Ok(())

}



#[allow(dead_code)]

async fn create_table_test_super_error(client: &Client) -> Result<(), aws_sdk_dynamodb::Error> {

    let _just_checking_compilation = client

        .create_table()

        .table_name("test")

        .key_schema(

            KeySchemaElement::builder()

                .attribute_name("year")

                .key_type(KeyType::Hash)

                .build()?,

        )

        .send()

        .await;

    Ok(())

}