Skip to content
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

Jump to bottom

Split the types and builders modules into per-shape private modules #2415

Merged
merged 1 commit into from
Feb 24, 2023
Merged

Split the types and builders modules into per-shape private modules #2415

merged 1 commit into from
Feb 24, 2023

Conversation

jdisanti
Copy link
Collaborator

Motivation and Context

This PR, behind the enableNewCrateOrganizationScheme feature flag, splits up the types and builders modules so that there is one private module per structure/enum/union shape, with the generated types being re-exported into the correct module. This significantly reduces file sizes which should improve IDE support (see aws-sdk-rust#716).

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@jdisanti
Copy link
Collaborator Author

Examining EC2 with these changes (with the feature enabled), there are only two modules larger than a megabyte:

aws-sdk/sdk/ec2$ find . -name '*.rs' -type f -size +1M
./src/client.rs
./src/xml_deser.rs

The client.rs clocks in at 2.1 MB for EC2, and it is arguably the most important to have under a megabyte since it's the entry point for all use of the SDK, so we'll have to figure out how to split it up as well. The vast majority of that file is documentation currently. I'm not sure if writing the docs to separate files and including them into the file would work for IDEs or make things worse.

xml_deser.rs is entirely private, so I'm not so concerned about that one.

I think this PR is a good first step though by splitting up types and builders.

@github-actions
Copy link

A new generated diff is ready to view.

  • AWS SDK (ignoring whitespace)
  • No codegen difference in the Client Test
  • No codegen difference in the Server Test
  • No codegen difference in the Server Test Python

A new doc preview is ready to view.

@jdisanti jdisanti marked this pull request as ready for review February 24, 2023 17:23
@jdisanti jdisanti requested review from a team as code owners February 24, 2023 17:23
@jdisanti jdisanti added this pull request to the merge queue Feb 24, 2023
Merged via the queue into main with commit 5183ccb Feb 24, 2023
@jdisanti jdisanti deleted the jdisanti-reorganize-crates-split-files branch February 24, 2023 20:24
thomas-k-cameron added a commit to thomas-k-cameron/smithy-rs that referenced this pull request Mar 5, 2023
@thomas-k-cameron
Squashed commit of the following:
7c2fa46 
commit 7ce8032
Author: John DiSanti <jdisanti@amazon.com>
Date:   Fri Mar 3 09:12:45 2023 -0800

    Make it possible to create `SdkError` context structs for tests (smithy-lang#2428)

commit 818343e
Author: Burak <unexge@gmail.com>
Date:   Thu Mar 2 17:43:42 2023 +0000

    Make `tools/ci-scripts/codegen-diff-revisions.py` fault tolerant (smithy-lang#2426)

commit 7ebfbcc
Author: ysaito1001 <gperson22@gmail.com>
Date:   Thu Mar 2 11:25:34 2023 -0600

    Move using-native-tls-instead-of-rustls to smithy-rs (smithy-lang#2423)

    * Move using-native-tls-instead-of-rustls to smithy-rs

    This commit adds the test `using-native-tls-instead-of-rustls` to
    `smithy-rs` that was originally in the `aws-doc-sdk-examples`.
    The test is more useful to be in `smithy-rs` because it can catch
    a test failure early prior to cutting a release.

    * Fix Copyright header

    * Update aws/sdk/integration-tests/using-native-tls-instead-of-rustls/tests/no-rustls-in-dependency.rs

    Co-authored-by: Zelda Hessler <zhessler@amazon.com>

    * Update aws/sdk/integration-tests/using-native-tls-instead-of-rustls/tests/no-rustls-in-dependency.rs

    Co-authored-by: Zelda Hessler <zhessler@amazon.com>

    * Update Cargo.toml

    This commit addresses
    smithy-lang#2423 (comment)
    smithy-lang#2423 (comment)

    ---------

    Co-authored-by: Yuki Saito <awsaito@amazon.com>
    Co-authored-by: Zelda Hessler <zhessler@amazon.com>

commit 049287d
Author: ysaito1001 <gperson22@gmail.com>
Date:   Tue Feb 28 14:35:08 2023 -0600

    Fix Inaccurate documentation on ProfileFileCredentialsProvider (smithy-lang#2421)

    This commit addresses awslabs/aws-sdk-rust#746.

    Co-authored-by: Yuki Saito <awsaito@amazon.com>

commit c3ae6f7
Author: Julian Antonielli <julianantonielli@gmail.com>
Date:   Tue Feb 28 20:26:20 2023 +0000

    Refactor event stream tests with `{client,server}IntegrationTest`s (smithy-lang#2342)

    * Refactor `ClientEventStreamUnmarshallerGeneratorTest` to use `clientIntegrationTest` (WIP)

    * Refactor `ClientEventStreamUnmarshallerGeneratorTest` with `clientIntegrationTest`

    * Refactor `ClientEventStreamUnmarshallerGeneratorTest` to use generic test cases

    * Start refactoring `ServerEventStreamUnmarshallerGeneratorTest`

    * Make `ServerEventStreamUnmarshallerGeneratorTest` tests work

    * Uncomment other test models

    * Allow unused on `parse_generic_error`

    * Rename `ServerEventStreamUnmarshallerGeneratorTest`

    * Make `EventStreamUnmarshallTestCases` codegenTarget-agnostic

    * Refactor `ClientEventStreamMarshallerGeneratorTest`: Tests run but fail

    * Refactor `ServerEventStreamMarshallerGeneratorTest`

    * Move `.into()` calls to `conditionalBuilderInput`

    * Add "context" to TODO

    * Fix client unmarshall tests

    * Fix clippy lint

    * Fix more clippy lints

    * Add docs for `event_stream_serde` module

    * Fix client tests

    * Remove `#[allow(missing_docs)]` from event stream module

    * Remove unused `EventStreamTestTools`

    * Add `smithy-validation-model` test dep to `codegen-client`

    * Temporarily add docs to make tests compile

    * Undo change in model

    * Make event stream unmarshaller tests a unit test

    * Remove unused code

    * Make `ServerEventStreamUnmarshallerGeneratorTest` a unit test

    * Make `ServerEventStreamMarshallerGeneratorTest` a unit test

    * Make `ServerEventStreamMarshallerGeneratorTest` pass

    * Make remaining tests non-integration tests

    * Make event stream serde module private again

    * Remove unnecessary clippy allowances

    * Remove clippy allowance

    * Remove docs for `event_stream_serde` module

    * Remove docs for `$unmarshallerTypeName::new`

    * Remove more unnecessary docs

    * Remove more superfluous docs

    * Undo unnecessary diffs

    * Uncomment last test

    * Make `conditionalBuilderInput` internal

commit 72df844
Author: Julian Antonielli <julianantonielli@gmail.com>
Date:   Tue Feb 28 07:47:21 2023 +0000

    Correct outdated details (smithy-lang#2420)

commit 9f7c49a
Author: Julian Antonielli <julianantonielli@gmail.com>
Date:   Mon Feb 27 12:12:37 2023 +0000

    Remove unused `wrk-api-bench` dependency (smithy-lang#2331)

    * Remove unused `wrk-api-bench` dependency

    * Remove benchmark file

commit dbafd68
Author: ysaito1001 <gperson22@gmail.com>
Date:   Fri Feb 24 19:31:41 2023 -0600

    Add crate versions in CHANGELOG (smithy-lang#2348)

    * Move rendering external contributors to a function

    This commit moves the code for rendering external contributors to its own
    function, in line with other render_* functions.

    * Add type alias `CrateVersionMetadataMap`

    This commit adds a type alias `CrateVersionMetadataMap` for a field in
    `VersionsManifest`. In a subsequent commit, the `changelogger` crate
    will refer to this field, and it's better for that crate to not use the
    field's bare type `BTreeMap<String, CrateVersion>`.

    * Render crate versions in CHANGELOG

    This commit addresses a pain point brought up in awslabs/aws-sdk-rust#731.
    A binary `changelogger` now has a new command line option
    `--current-release-versions-manifest` that points to the latest
    `versions.toml` in the `aws-sdk-rust` repository. The program
    will generate a markdown table showing crate versions from that
    manifest and include it in an expand/collapse section.

    * Add a leading pipe when rendering markdown table

    This commit addresses smithy-lang#2348 (comment)

    ---------

    Co-authored-by: Yuki Saito <awsaito@amazon.com>
    Co-authored-by: Zelda Hessler <zhessler@amazon.com>

commit 5183ccb
Author: John DiSanti <jdisanti@amazon.com>
Date:   Fri Feb 24 11:53:09 2023 -0800

    Split the `types` and `builders` modules into per-shape private modules (smithy-lang#2415)

commit 4c76847
Author: david-perez <d@vidp.dev>
Date:   Fri Feb 24 13:22:51 2023 +0100

    Enclose missing Rust template parameters in backticks in the exception message (smithy-lang#1492)

    * Enclose missing Rust template parameters in backticks in the exception message

    * appease ktlint

    * ./gradlew ktlintFormat

commit e23790e
Author: ysaito1001 <gperson22@gmail.com>
Date:   Thu Feb 23 18:29:53 2023 -0600

    Remove InvalidUri from external-types.toml (smithy-lang#2414)

    Co-authored-by: Yuki Saito <awsaito@amazon.com>

commit 38665d2
Author: John DiSanti <jdisanti@amazon.com>
Date:   Wed Feb 22 18:03:25 2023 -0800

    Fix lint

commit 3221246
Author: John DiSanti <jdisanti@amazon.com>
Date:   Fri Feb 17 10:23:57 2023 -0800

    Reorganize the types/models/primitives modules

commit 0da92a4
Author: John DiSanti <jdisanti@amazon.com>
Date:   Thu Feb 23 12:12:11 2023 -0800

    Move fluent builders and hide the parse strict response impl struct (smithy-lang#2401)

    * Hide the operation parse impl structs

    * Move fluent builders into per-operation modules

commit 3d40835
Author: Russell Cohen <rcoh@amazon.com>
Date:   Thu Feb 23 14:56:24 2023 -0500

    Use rustls for reqwest (smithy-lang#2403)

    * Use rustls for reqwest

    This also adds a CI check to ensure that we can build the SDK on MUSL

    * Fix MUSL build in image

    * Fix build image

commit 530386e
Author: Harry Barber <106155934+hlbarber@users.noreply.github.com>
Date:   Thu Feb 23 19:48:37 2023 +0000

    Update changelog to reflect 0.54.x branch releases (smithy-lang#2411)

commit 14bd809
Author: John DiSanti <jdisanti@amazon.com>
Date:   Thu Feb 23 09:19:27 2023 -0800

    Add builder symbol/module resolution to symbol providers (smithy-lang#2395)

    * Add builder symbol/module resolution to symbol providers

    * Back out breaking changes

    * Reduce codegen diff

    * Fix server example clippy lints

    * Associate smithy-lang#2396 with TODO comments

    * Improve doc comment

    * Revert doc hidden change

commit 76582ba
Author: John DiSanti <jdisanti@amazon.com>
Date:   Wed Feb 22 16:03:54 2023 -0800

    Move `AppName` and `PKG_VERSION` (smithy-lang#2389)

    * Move `AppName` and `PKG_VERSION`

    * Fix merge issue

commit 08c16d3
Author: John DiSanti <jdisanti@amazon.com>
Date:   Wed Feb 22 15:37:32 2023 -0800

    Fix escaping of `Self` in symbol providers (smithy-lang#2381)

    * Fix escaping of `Self` in symbol providers

    * Clean up an old hack

commit 6dd7bc7
Author: John DiSanti <jdisanti@amazon.com>
Date:   Wed Feb 22 15:38:03 2023 -0800

    Reorganize more modules and re-exports (smithy-lang#2400)

    * Conditionally re-export the Smithy Client Builder in clients
    * Reorganize error type re-export
    * Reorganize the `paginator` module
    * Flatten the `presigning` module
    * Hide the `http_body_checksum` module

commit 7cffe14
Author: John DiSanti <jdisanti@amazon.com>
Date:   Wed Feb 22 13:20:43 2023 -0800

    Remove `toEnumVariantName` from `RustSymbolProvider` (smithy-lang#2377)

    The `toEnumVariantName` function existed on symbol provider to work
    around enum definitions not being shapes. In the future when we refactor
    to use `EnumShape` instead of `EnumTrait`, there will be `MemberShape`s
    for each enum member. This change incrementally moves us to that future
    by creating fake `MemberShape`s in the enum generator from the enum
    definition.

commit da26405
Author: ysaito1001 <gperson22@gmail.com>
Date:   Wed Feb 22 15:04:48 2023 -0600

    Add support for the awsQueryCompatible trait (smithy-lang#2398)

    * Add support for the awsQueryCompatible trait

    This commit adds support for the awsQueryCompatible trait. This allows
    services already supporting custom error codes through the AWS Query
    protocol with the awsQueryError trait to continue supporting them after
    the services switch to the AWS JSON 1.0 protocol.

    * Add copyright header

    * Fix clippy warning for clippy::manual-map

    * Update CHANGELOG.next.toml

    * Update CHANGELOG.next.toml

    * Update CHANGELOG.next.toml

    * Remove unused variables from `errorScope`

    This commit addresses smithy-lang#2398 (comment)

    * Reorder arguments for test verification

    This commit addresses smithy-lang#2398 (comment)

    ---------

    Co-authored-by: Yuki Saito <awsaito@amazon.com>

commit d579c56
Author: Russell Cohen <rcoh@amazon.com>
Date:   Wed Feb 22 14:25:52 2023 -0500

    Fix docker image hash script to be contained to ci-build (smithy-lang#2404)

commit 85d2ace
Author: John DiSanti <jdisanti@amazon.com>
Date:   Wed Feb 22 10:21:06 2023 -0800

    Upgrade Kotlin and Ktlint (smithy-lang#2392)

    * Upgrade Kotlin to 1.7.21

    * Upgrade Ktlint to 0.48.2

    * Run `pre-commit run --all-files` to fix broken Ktlints

    * Fix string comparison broken by code formatting

commit ec1a551
Author: ysaito1001 <gperson22@gmail.com>
Date:   Tue Feb 21 14:44:15 2023 -0600

    Address clippy warnings in pokemon-service (smithy-lang#2399)

    Co-authored-by: Yuki Saito <awsaito@amazon.com>

commit a40dbfc
Author: John DiSanti <jdisanti@amazon.com>
Date:   Fri Feb 17 13:20:11 2023 -0800

    Reorganize credentials, endpoints, region, and op customization (smithy-lang#2393)

    * Move `Endpoint` re-export into `config`

    * Move `Credentials` and `Region`

    * Move `customize` into `crate::client`

    * Clean up `RustModule`

commit 86bddca
Author: John DiSanti <jdisanti@amazon.com>
Date:   Fri Feb 17 13:19:45 2023 -0800

    Move inputs, outputs, and op errors into operation modules (smithy-lang#2394)

commit afb1f16
Author: John DiSanti <jdisanti@amazon.com>
Date:   Fri Feb 17 12:17:59 2023 -0800

    Move `RustSymbolProvider` and related types out of `SymbolVisitor` (smithy-lang#2380)

    * Move base `RustSymbolProvider` types out of `SymbolVisitor`
    * Rename `SymbolVisitorConfig` to `RustSymbolProviderConfig`

commit 3d00767
Author: Fahad Zubair <fahadzubair@gmail.com>
Date:   Fri Feb 17 19:21:01 2023 +0000

    Constraint member types are refactored as standalone shapes. (smithy-lang#2256)

    * Constraint member types are refactored as standalone shapes.

    * ModelModule to ServerRustModule.model

    * Constraints are written to the correct module

    * Code generates for non-public constrained types.

    * Removed a comment

    * Using ConcurrentHashmap just to be on the safe side

    * Clippy warnings removed on constraints, k.into() if gated

    * Wordings for some of the checks changed

    * Test need to call rustCrate.renderInlineMemoryModules

    * ktlintFormat related changes

    * RustCrate need to be passed for server builder

    * Param renamed in getParentAndInlineModuleForConstrainedMember

    * pubCrate to publicConstrainedType rename

    * PythonServer symbol builder needed to pass publicConstrainedTypes

    * @required still remains on the member shape after transformation

    * ConcurrentLinkedQueue used for root RustWriters

    * runTestCase does not run the tests but just sets them up, hence has been renamed

    * CHANGELOG added

    ---------

    Co-authored-by: Fahad Zubair <fahadzub@amazon.com>

commit 5a5a7c4
Author: 82marbag <69267416+82marbag@users.noreply.github.com>
Date:   Fri Feb 17 13:19:34 2023 -0500

    Nested server structure member shapes targeting simple shapes with default trait (smithy-lang#2352)

    * Nested server structure member shapes targeting simple shapes with `@default`

    Signed-off-by: Daniele Ahmed <ahmeddan@amazon.de>

    * Add changelog entry

    Signed-off-by: Daniele Ahmed <ahmeddan@amazon.de>

    * Update CHANGELOG

    Signed-off-by: Daniele Ahmed <ahmeddan@amazon.de>

    * Add unit test

    Signed-off-by: Daniele Ahmed <ahmeddan@amazon.de>

    * Add integration test

    Signed-off-by: Daniele Ahmed <ahmeddan@amazon.de>

    * Change method

    Signed-off-by: Daniele Ahmed <ahmeddan@amazon.de>

    * Include comment to describe the test

    Signed-off-by: Daniele Ahmed <ahmeddan@amazon.de>

    ---------

    Signed-off-by: Daniele Ahmed <ahmeddan@amazon.de>

commit 198c500
Author: david-perez <d@vidp.dev>
Date:   Fri Feb 17 18:24:25 2023 +0100

    Disallow `@uniqueItems`-constrained list shapes that reach a map shape (smithy-lang#2375)

    * Disallow `@uniqueItems`-constrained list shapes that reach a map shape

    The server SDK codegen generates Rust code that does not compile when a
    `@uniqueItems`-constrained list shape reaches a map shape, essentially
    because `std::collections::HashMap` does not implement
    `std::hash::Hash`.

    A ticket with the Smithy team was opened in smithy-lang/smithy#1567 to
    disallow such models.

    This commit makes it so that codegen aborts with an informative message
    when such models are encountered, instead of going ahead and producing
    code that does not compile.

    This commit also slightly adjusts the error messages produced when
    unsupported constraint traits are found.

    * ./gradlew ktlintFormat

commit b9f8090
Author: ysaito1001 <gperson22@gmail.com>
Date:   Fri Feb 17 10:21:24 2023 -0600

    Ensure cache miss logging works in concurrent setting (smithy-lang#2391)

    This commit ensures that logging for cache miss should be displayed
    properly when multiple threads execute `get_or_load` concurrently.
    Specifically, the log should be displayed only once for the first thread
    that succeeds in populating a cache value.

    Co-authored-by: Yuki Saito <awsaito@amazon.com>

commit 52b07c2
Author: John DiSanti <jdisanti@amazon.com>
Date:   Thu Feb 16 11:21:24 2023 -0800

    Add feature flag for the crate reorganization (smithy-lang#2388)

commit ba3b937
Author: Russell Cohen <rcoh@amazon.com>
Date:   Thu Feb 16 14:11:36 2023 -0500

    Add presigned URL canary & ep2 test (smithy-lang#2379)

    * Add presigned URL canary & ep2 test

    * fix canary tests

commit d54c005
Author: Zelda Hessler <zhessler@amazon.com>
Date:   Thu Feb 16 11:50:42 2023 -0600

    add: deprecation notice to deprecated fluent builder methods (smithy-lang#2386)

    * add: deprecation notice to deprecated fluent builder methods

    * add: CHANGELOG.next.toml notes

commit 42671dd
Author: Nugine <nugine@foxmail.com>
Date:   Thu Feb 16 23:53:19 2023 +0800

    Upgrade `base64-simd` to 0.8 (smithy-lang#2384)

commit f7ac844
Author: John DiSanti <jdisanti@amazon.com>
Date:   Thu Feb 16 07:52:40 2023 -0800

    Add generic client codegen diff to PR bot (smithy-lang#2383)

commit 2473c5c
Author: Eduardo de Moura Rodrigues <16357187+eduardomourar@users.noreply.github.com>
Date:   Thu Feb 16 02:15:40 2023 +0100

    feat(codegen): support for api key auth trait (smithy-lang#2154)

    * feat(codegen): support for api key auth trait

    * chore: update to new codegen decorator interface

    * chore: include basic test

    * chore: set api key into rest xml extras model

    * chore: update test

    * chore: refactor api key definition map

    * feat(codegen): add api key decorator by default

    * chore: add smithy-http-auth to runtime type

    * chore: reference new smithy-http-auth crate

    * Update codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/customizations/ApiKeyAuthDecorator.kt

    Co-authored-by: John DiSanti <johndisanti@gmail.com>

    * Update codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/customizations/ApiKeyAuthDecorator.kt

    Co-authored-by: John DiSanti <johndisanti@gmail.com>

    * Update codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/customizations/ApiKeyAuthDecorator.kt

    Co-authored-by: John DiSanti <johndisanti@gmail.com>

    * Revert "chore: set api key into rest xml extras model"

    This reverts commit 93b99c8.

    * chore: moved api key re-export to extras customization

    * chore: include test for auth in query and header

    * chore: fix linting

    * Update codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/customizations/ApiKeyAuthDecorator.kt

    Co-authored-by: John DiSanti <johndisanti@gmail.com>

    * Update codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/customizations/ApiKeyAuthDecorator.kt

    Co-authored-by: John DiSanti <johndisanti@gmail.com>

    * Update codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/customizations/ApiKeyAuthDecorator.kt

    Co-authored-by: John DiSanti <johndisanti@gmail.com>

    * Update codegen-client/src/test/kotlin/software/amazon/smithy/rust/codegen/client/customizations/ApiKeyAuthDecoratorTest.kt

    Co-authored-by: John DiSanti <johndisanti@gmail.com>

    * Update codegen-client/src/test/kotlin/software/amazon/smithy/rust/codegen/client/customizations/ApiKeyAuthDecoratorTest.kt

    Co-authored-by: John DiSanti <johndisanti@gmail.com>

    * chore: add doc hidden to re-export

    * chore: ensure extras are added only if it applies

    * Revert "chore: add doc hidden to re-export"

    This reverts commit 8a49e2b.

    ---------

    Co-authored-by: Eduardo Rodrigues <eduardomourar@users.noreply.github.com>
    Co-authored-by: John DiSanti <jdisanti@amazon.com>
    Co-authored-by: John DiSanti <johndisanti@gmail.com>

commit f9fb9e6
Author: david-perez <d@vidp.dev>
Date:   Wed Feb 15 23:09:37 2023 +0100

    Fix recursive constraint violations with paths over list and map shapes (smithy-lang#2371)

    * Fix recursive constraint violations with paths over list and map shapes

    There is a widespread assumption throughout the generation of constraint
    violations that does not hold true all the time, namely, that a
    recursive constraint violation graph has the same requirements with
    regards to boxing as the regular shape graph.

    Some types corresponding to recursive shapes are boxed to introduce
    indirection and thus not generate an infinitely recursive type. The
    algorithm however does not superfluously introduce boxes when the cycle
    goes through a list shape or a map shape. Why list shapes and map
    shapes? List shapes and map shapes get rendered in Rust as `Vec<T>` and
    `HashMap<K, V>`, respectively, they're the only Smithy shapes that
    "organically" introduce indirection (via a pointer to the heap) in the
    recursive path. For other recursive paths, we thus have to introduce the
    indirection artificially ourselves using `Box`. This is done in the
    `RecursiveShapeBoxer` model transform.

    However, the constraint violation graph needs to box types in recursive
    paths more often. Since we don't collect constraint violations
    (yet, see smithy-lang#2040), the constraint violation graph never holds
    `Vec<T>`s or `HashMap<K, V>`s, only simple types. Indeed, the following simple
    recursive model:

    ```smithy
    union Recursive {
        list: List
    }

    @Length(min: 69)
    list List {
        member: Recursive
    }
    ```

    has a cycle that goes through a list shape, so no shapes in it need
    boxing in the regular shape graph. However, the constraint violation
    graph is infinitely recursive if we don't introduce boxing somewhere:

    ```rust
    pub mod model {
        pub mod list {
            pub enum ConstraintViolation {
                Length(usize),
                Member(
                    usize,
                    crate::model::recursive::ConstraintViolation,
                ),
            }
        }

        pub mod recursive {
            pub enum ConstraintViolation {
                List(crate::model::list::ConstraintViolation),
            }
        }
    }
    ```

    This commit fixes things by making the `RecursiveShapeBoxer` model
    transform configurable so that the "cycles through lists and maps
    introduce indirection" assumption can be lifted. This allows a server
    model transform, `RecursiveConstraintViolationBoxer`, to tag member
    shapes along recursive paths with a new trait,
    `ConstraintViolationRustBoxTrait`, that the constraint violation type
    generation then utilizes to ensure that no infinitely recursive
    constraint violation types get generated.

    For example, for the above model, the generated Rust code would now look
    like:

    ```rust
    pub mod model {
        pub mod list {
            pub enum ConstraintViolation {
                Length(usize),
                Member(
                    usize,
                    std::boxed::Box(crate::model::recursive::ConstraintViolation),
                ),
            }
        }

        pub mod recursive {
            pub enum ConstraintViolation {
                List(crate::model::list::ConstraintViolation),
            }
        }
    }
    ```

    Likewise, places where constraint violations are handled (like where
    unconstrained types are converted to constrained types) have been
    updated to account for the scenario where they now are or need to be
    boxed.

    Parametrized tests have been added to exhaustively test combinations of
    models exercising recursive paths going through (sparse and non-sparse)
    list and map shapes, as well as union and structure shapes
    (`RecursiveConstraintViolationsTest`). These tests even assert that the
    specific member shapes along the cycles are tagged as expected
    (`RecursiveConstraintViolationBoxerTest`).

    * Address comments

commit 6cade90
Author: John DiSanti <jdisanti@amazon.com>
Date:   Wed Feb 15 13:36:09 2023 -0800

    Move symbol extension functions into `SymbolExt` (smithy-lang#2378)

commit 1c1a3ef
Author: david-perez <d@vidp.dev>
Date:   Wed Feb 15 16:09:42 2023 +0100

    Allow server decorators to postprocess `ValidationException` not attached error messages (smithy-lang#2338)

    Should they want to, a server decorator can now postprocess the error
    message that arises when a constrained operation does not have the
    `ValidationException` shape attached to its errors.

    This commit adds a test to ensure that when such a decorator is
    registered, the `ValidationResult` can indeed be altered, but no such
    decorator is added to the `rust-server-codegen` plugin.

commit d7f8130
Author: Harry Barber <106155934+hlbarber@users.noreply.github.com>
Date:   Wed Feb 15 11:45:56 2023 +0000

    Update the service builder RFCs (smithy-lang#2374)

    * Complete service_builder.md

    * Complete refine_builder.md

commit 181889d
Author: Julian Antonielli <julianantonielli@gmail.com>
Date:   Tue Feb 14 16:23:31 2023 +0000

    Fix manifest path comma (smithy-lang#2369)

commit 18a26b6
Author: Luca Palmieri <20745048+LukeMathWalker@users.noreply.github.com>
Date:   Tue Feb 14 15:36:28 2023 +0000

    Add quotes to get a valid Javascript string (smithy-lang#2367)

commit 10bb26c
Author: Luca Palmieri <20745048+LukeMathWalker@users.noreply.github.com>
Date:   Tue Feb 14 15:36:14 2023 +0000

    Add tests to make sure the publisher works as expected. (smithy-lang#2365)

    * Add tests to make sure the publisher works as expected.

    * Fix lint.

commit ca3ef20
Author: Luca Palmieri <20745048+LukeMathWalker@users.noreply.github.com>
Date:   Tue Feb 14 13:27:37 2023 +0000

    Fix version regex. (smithy-lang#2364)

commit aa07854
Author: Zelda Hessler <zhessler@amazon.com>
Date:   Mon Feb 13 17:32:59 2023 -0600

    Fix S3 canary match statement (smithy-lang#2358)

    * fix: s3 canary error match

    * update: use Error.is_ to check for "no such key" error in canary

    * remove: leftover import

commit 1d1e68a
Author: Eduardo de Moura Rodrigues <16357187+eduardomourar@users.noreply.github.com>
Date:   Tue Feb 14 00:07:06 2023 +0100

    feat(smithy-http-auth): add api key auth types (smithy-lang#2153)

    * feat(aws-types): add api key to configuration

    * chore: set package version to 0.52.0

    * feat(aws-smithy-types): create auth types

    * chore: use auth from smithy types

    * chore: fix return self type

    * chore: create http auth definition type

    * chore: add constructor for http auth definition

    * chore: ensure properties are not moved

    * chore: create convenience constructors

    * chore: add some todo comments

    * feat: move query writer to aws-smithy-http crate

    * chore(codegen): expose smithy http tower dependency

    * chore: remove setters for auth definition

    * chore: fix logical error for scheme not allowed

    * chore: add constructor for basic and digest auth

    * chore: allow equality comparision for api key

    * Revert "chore: set package version to 0.52.0"

    This reverts commit da660fc.

    * chore: fix additional references to querywriter

    * chore: implement from string for api key struct

    * chore: disallow none api key in sdk config

    * chore: fix formatting

    * chore: add unit tests for auth types

    * chore: add auth api key to external types

    * chore: make query writer doc hidden

    * feat: create aws-smithy-http-auth crate

    * chore: use zeroing for auth api key

    * chore: use builder pattern for auth definition

    * chore: restructure http auth package

    * chore: define default lint warning

    * chore: include http auth in runtime common list

    * chore: define setter for optional scheme

    * chore: should panic while building auth definition

    * chore: return missing required field error

    * chore: make few code simplications for api key

    * Revert "chore: add auth api key to external types"

    This reverts commit b2318b0.

    * chore: revert api key from sdk config

    * chore: panic on missing required field

    * Opt out of `clippy::derive_partial_eq_without_eq`

    ---------

    Co-authored-by: Eduardo Rodrigues <eduardomourar@users.noreply.github.com>
    Co-authored-by: John DiSanti <jdisanti@amazon.com>

commit 10520d7
Author: Zelda Hessler <zhessler@amazon.com>
Date:   Mon Feb 13 16:45:50 2023 -0600

    Fix: native-tls client creation to support HTTPS again (smithy-lang#2360)

    * update: use `enforce_http = false` when creating native-tls hyper connector
    refactor: move smithy conns module to its own file
    add: sanity tests ensuring we can make HTTP and HTTPS requests with the rustls and native-tls connectors
    remove: `use crate::*` imports in favor of explicit imports

    * update: CHANGELOG.next.toml

    * add: feature gate to conns tests

commit f7c550e
Author: John DiSanti <jdisanti@amazon.com>
Date:   Mon Feb 13 11:38:57 2023 -0800

    Fix CI for forks by moving merge queue runs into a separate workflow (smithy-lang#2359)

commit 9ecd7f0
Author: Harry Barber <106155934+hlbarber@users.noreply.github.com>
Date:   Mon Feb 13 18:25:56 2023 +0000

    Fix consistent service naming and add test coverage (smithy-lang#2349)

    * Make service name casing consistent

    * Add naming-obstacle-course-casing.smithy

    * Add missing import

    * Relax obstacle course even further

    * Better TODO

    * Add CHANGELOG.next.toml

commit f705bde
Author: Luca Palmieri <20745048+LukeMathWalker@users.noreply.github.com>
Date:   Mon Feb 13 17:33:14 2023 +0000

    Idempotent release action (smithy-lang#2353)

    * Do not require the released commit to be at the tip of the branch.

    * Update comment.

    * If you release an old commit, it must be ready to go as is.

    * Tag the commit that updates gradle.properties.

    * Check out the specific commit instead of the branch.

    * Simplify.

    * We need to set the release branch.

    * You can't refer to outputs directly.

    * Make sure to tag the right commit.

    * Pass the commit SHA explicitly.

commit c060263
Author: Luca Palmieri <20745048+LukeMathWalker@users.noreply.github.com>
Date:   Mon Feb 13 17:32:26 2023 +0000

    Do not run the PR bot on the merge queue (smithy-lang#2357)

    * Do not run the PR bot on the merge queue

    * Update ci-pr.yml

commit bfbe25e
Author: Luca Palmieri <20745048+LukeMathWalker@users.noreply.github.com>
Date:   Mon Feb 13 17:25:48 2023 +0000

    Do not skip CI jobs for merge queue events. (smithy-lang#2356)

    * Do not skip for merge queue events.

    * Fix quotes.

commit b3b3393
Author: Luca Palmieri <20745048+LukeMathWalker@users.noreply.github.com>
Date:   Mon Feb 13 17:01:01 2023 +0000

    Run CI on merge groups. (smithy-lang#2355)

commit e63f3ee
Author: david-perez <d@vidp.dev>
Date:   Mon Feb 13 12:41:43 2023 +0100

    Simplify `simple.smithy` (smithy-lang#2339)

    `simple.smithy` is currently not that simple. Besides, it serves no
    effective purpose: everything that the model exercises is already
    exercised in a clearer and more orderly manner in other integration
    tests.

    This PR makes the model minimal, so that it recovers its purpose as a
    simple smoke test. Contributors can also use the model as a scratchpad
    for features or bugfixs they're working on.

commit d48878e
Author: John DiSanti <jdisanti@amazon.com>
Date:   Fri Feb 10 17:36:48 2023 -0800

    Implement request ID access for SDK clients RFC (smithy-lang#2129)

    * Add `RequestId` trait
    * Implement `RequestId` for generated AWS client errors
    * Move `RustWriter.implBlock` out of `StructureGenerator`
    * Create structure/builder customization hooks
    * Customize `_request_id` into AWS outputs
    * Set request ID on outputs
    * Refactor SDK service decorators
    * Refactor S3's extended request ID implementation
    * Combine `Error` and `ErrorKind`
    * Add test for service error conversion
    * Move error generators into `codegen-client` and fix tests
    * Re-export `ErrorMetadata`
    * Add request IDs to trace logs
    * Simplify some error trait handling
    * Rename `ClientContextParamDecorator` to `ClientContextConfigCustomization`
    * Add deprecated alias to guide customers through upgrading
    * Rename the `ErrorMetadata` trait to `ProvideErrorMetadata`
    * Rename `aws_smithy_types::Error` to `ErrorMetadata`

commit 0a11d51
Author: ysaito1001 <gperson22@gmail.com>
Date:   Fri Feb 10 17:03:38 2023 -0600

    Add jitter to `LazyCredentialsCache` (smithy-lang#2335)

    * Add jitter to `LazyCredentialsCache`

    This commit adds jitter to `LazyCredentialsCache`. A jitter provides a
    mechanism for randomizing the buffer time for credentials. This allows
    credentials with the same expiry to expire at slightly different times,
    thereby preventing thundering herds.

    * Update CHANGELOG.next.toml

    ---------

    Co-authored-by: Yuki Saito <awsaito@amazon.com>

commit cdc710d
Author: John DiSanti <jdisanti@amazon.com>
Date:   Fri Feb 10 14:21:16 2023 -0800

    Make modules in `codegen-core` configurable (smithy-lang#2336)

    * Refactor modules to be configurable in `codegen-core`
    * Remove panicking default test symbol provider
    * Remove as many references to Error/Types as possible
    * Rename module constants

commit de18667
Author: Nugine <nugine@foxmail.com>
Date:   Sat Feb 11 04:59:31 2023 +0800

    Bump Rust MSRV to 1.63.0 (smithy-lang#2222)

    Co-authored-by: Zelda Hessler <zhessler@amazon.com>
    Co-authored-by: John DiSanti <jdisanti@amazon.com>

commit 13b10d5
Author: John DiSanti <jdisanti@amazon.com>
Date:   Fri Feb 10 11:07:56 2023 -0800

    Add RFC for improving request ID access in SDK clients (smithy-lang#2083)

commit e84ef6c
Author: Burak <unexge@gmail.com>
Date:   Fri Feb 10 14:00:53 2023 +0000

    Python: Type-stub generation for SSDKs (smithy-lang#2149)

    * Initial Python stub generation

    * Handle default values correctly

    * Only generate `__init__` for classes that have constructor signatures

    * Preserve doc comments

    * Make context class generic

    * Put type hint into a string to fix runtime error

    * Run `mypy` on CI

    * Use `make` to build Python SSDKs while generating diffs

    * Escape Python types in Rust comments

    * Only mark class methods with

    * Sort imports to minimize diffs

    * Add type annotations for `PySocket`

    * Dont extend classes from `object` as every class already implicitly extended from `object`

    * Use `vars` instead of `inspect.getmembers` to skip inherited members of a class

    * Fix linting issues

    * Add some tests for stubgen and refactor it

    * Add type annotations to `PyMiddlewareException`

    * Fix tests on Python 3.7

    Python 3.7 doesn't support reading signatures from `__text_signature__`
    for non-builtin functions (i.e. C/Rust functions). For testing we're using
    regular Python syntax for defining signature.

    * Provide default values for `typing.Optional[T]` types in type-stubs

    * Update `is_fn_like` to cover more cases

    * Remove `tools/smithy-rs-tool-common/`

    * Make `DECORATORS` an array instead of a list

    * Ignore missing type stub errors for `aiohttp`

commit 086d965
Author: John DiSanti <jdisanti@amazon.com>
Date:   Thu Feb 9 12:10:31 2023 -0800

    Refactor client/server logic out of `EnumGenerator` (smithy-lang#2334)

    * Refactor client/server enum generation logic into new `EnumType`
    * Move client enum logic into `codegen-client`

commit bae9380
Author: Zelda Hessler <zhessler@amazon.com>
Date:   Thu Feb 9 11:02:19 2023 -0600

    Update pretty_assertions (smithy-lang#2332)

    * update: pretty_assertions

    * update: just use v1.3

commit 78203c0
Author: 82marbag <69267416+82marbag@users.noreply.github.com>
Date:   Thu Feb 9 09:43:03 2023 -0500

    RestJson with body expects application/json content type (smithy-lang#2330)

    Signed-off-by: Daniele Ahmed <ahmeddan@amazon.de>

commit bf678fd
Author: Luca Palmieri <20745048+LukeMathWalker@users.noreply.github.com>
Date:   Thu Feb 9 13:16:41 2023 +0000

    [Release workflow] Workaround for the ownership bug (smithy-lang#2318)

    * First publish everything, then try to correct ownership.

    * Avoid trying to remove teams, since we know it won't succeed.

    * Fix warning and update dependencies.

    * Avoid allocation unless necessary.

    * Get full error representation for retryable failures.

    * We want to hash the file content, not the file path.

commit a3075ea
Author: david-perez <d@vidp.dev>
Date:   Wed Feb 8 23:14:31 2023 +0100

    Move converters from constraint violations into `ValidationException` to decorators (smithy-lang#2302)

    This allows "easily" converting to other custom validation exception
    shapes by implementing a decorator.

    As a simple example, this PR adds a
    `CustomValidationExceptionWithReasonDecorator` decorator that is able to
    convert into a shape that is very similar to
    `smithy.framework#ValidationException`, but that has an additional
    `reason` field. The decorator can be enabled via the newly added
    `experimentalCustomValidationExceptionWithReasonPleaseDoNotUse` codegen
    config flag.

    This effectively provides a way for users to use custom validation
    exceptions without having to wait for the full implementation of smithy-lang#2053,
    provided they're interested enough to write a decorator in a JVM
    language. This mechanism is _experimental_ and will be removed once full
    support for custom validation exceptions as described in smithy-lang#2053 lands,
    hence why the configuration key is strongly worded in this respect.

    This commit also ports the mechanism to run codegen integration tests
    within Kotlin unit tests for client SDKs to the server. See smithy-lang#1956 for
    details. The custom validation exception decorator is tested this way.

commit bb6155a
Author: John DiSanti <jdisanti@amazon.com>
Date:   Tue Feb 7 16:16:11 2023 -0800

    Remove `codegen-client` dependency from Python server (smithy-lang#2307)

commit b1ee45a
Author: Julian Antonielli <julianantonielli@gmail.com>
Date:   Tue Feb 7 16:45:57 2023 +0000

    Fix  protocol test: `RestJsonMalformedPatternSensitiveString` (smithy-lang#2321)

    * Make `RestJsonMalformedPatternSensitiveString` pass

    * Use `AwsJson11` variable instead of hardcoded string

    * Refactor `errorMessage` into private function

    * Add comment about remaining `@range` on floats tests

    * Use `AwsJson11` variable instead of hardcoded string (missed one)

    * Use `hasTrait` over `getTrait() != null`

commit 12a66c2
Author: Luca Palmieri <20745048+LukeMathWalker@users.noreply.github.com>
Date:   Tue Feb 7 16:20:03 2023 +0000

    Instruct the release script to tag the commit on the release branch. It was previously left unspecified, resulting on a tag on the `main` branch. (smithy-lang#2322)

commit 18bfa20
Author: Luca Palmieri <20745048+LukeMathWalker@users.noreply.github.com>
Date:   Tue Feb 7 15:25:37 2023 +0000

    Remove entries that have been released in 0.54.2. (smithy-lang#2323)

commit 3ee62e8
Author: david-perez <d@vidp.dev>
Date:   Tue Feb 7 13:51:35 2023 +0100

    RFC: Better Constraint Violations (smithy-lang#2040)

commit 0226446
Author: david-perez <d@vidp.dev>
Date:   Mon Feb 6 19:16:43 2023 +0100

    Rename Rust server codegen plugins (smithy-lang#2306)

    Rename `RustCodegenServerPlugin` to `RustServerCodegenPlugin`, for
    consistency with `RustClientCodegenPlugin`. This is a better name, since
    the plugin is named `rust-server-codegen`.

    This commit also renames `PythonCodegenServerPlugin` to
    `RustServerCodegenPythonPlugin` for the same reasons.

    This commit also contains other drive-by improvements made while working
    on smithy-lang#2302.

commit 7fdb5c9
Author: Luca Palmieri <20745048+LukeMathWalker@users.noreply.github.com>
Date:   Mon Feb 6 16:39:38 2023 +0000

    Fetch history when cloning, otherwise git commands such as `rev-parse` could fail. (smithy-lang#2314)

commit a389ea2
Author: Luca Palmieri <20745048+LukeMathWalker@users.noreply.github.com>
Date:   Mon Feb 6 16:30:33 2023 +0000

    Enforce the same minimum TLS version (1.2) for both TLS backends (smithy-lang#2312)

    * Enforce the same minimum TLS version (1.2) for both TLS backends

    * Add CHANGELOG entry

    * Add documentation for both `https` and `native_tls`.

    * Remove unnecessary mut

commit 51047b1
Author: Luca Palmieri <20745048+LukeMathWalker@users.noreply.github.com>
Date:   Mon Feb 6 16:03:43 2023 +0000

    Use `refs/remote/<remote-name>/<branch-name>` to avoid a "Fatal: needed a single revision" error, as we have seen in https://github.com/awslabs/smithy-rs/actions/runs/4105169302/jobs/7082226485 (smithy-lang#2313)

commit c9275fb
Author: Russell Cohen <rcoh@amazon.com>
Date:   Mon Feb 6 10:12:17 2023 -0500

    Prevent test dependencies from leaking into production (smithy-lang#2264)

    * Prevent test dependencies from leaking into production

    * refactor & fix tests

    * fix tests take two

    * fix more tests

    * Fix missed called to mergeDependencyFeatures

    * Add test

    * fix glacier compilation

    * fix more tests

    * fix one more test
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Velfi Velfi Velfi approved these changes

@david-perez david-perez Awaiting requested review from david-perez david-perez was automatically assigned from awslabs/smithy-rs-server

@weihanglo weihanglo Awaiting requested review from weihanglo weihanglo was automatically assigned from awslabs/smithy-rs-server

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jdisanti @Velfi