Unverified Commit 71b401f5 authored by John DiSanti's avatar John DiSanti Committed by GitHub
Browse files

Move endpoint module and add endpoint re-exports (#2822) 

All the types in the `crate::endpoint` module are related to endpoint
configuration, so they should be moved into `crate::config::endpoint` to
be consistent with the rest of the generated crate organization. This PR
moves them for the orchestrator implementation, but retains them in
`crate::endpoint` when generating for middleware.

----

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

codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/ClientRustModule.kt

+15 −1
Original line number Diff line number Diff line
@@ -60,6 +60,9 @@ object ClientRustModule { 
        /** crate::client */

        val self = RustModule.public("config")



        /** crate::config::endpoint */

        val endpoint = RustModule.public("endpoint", parent = self)



        /** crate::config::retry */

        val retry = RustModule.public("retry", parent = self)
@@ -70,8 +73,18 @@ object ClientRustModule { 
        val interceptors = RustModule.public("interceptors", parent = self)

    }



    val Error = RustModule.public("error")

    // TODO(enableNewSmithyRuntimeCleanup): Delete this root endpoint module

    @Deprecated(message = "use the endpoint() method to get the endpoint module for now")

    val Endpoint = RustModule.public("endpoint")



    // TODO(enableNewSmithyRuntimeCleanup): Just use Config.endpoint directly and delete this function

    fun endpoint(codegenContext: ClientCodegenContext): RustModule.LeafModule = if (codegenContext.smithyRuntimeMode.defaultToMiddleware) {

        Endpoint

    } else {

        Config.endpoint

    }



    val Error = RustModule.public("error")

    val Operation = RustModule.public("operation")

    val Meta = RustModule.public("meta")

    val Input = RustModule.public("input")
@@ -99,6 +112,7 @@ class ClientModuleDocProvider( 
            ClientRustModule.client -> clientModuleDoc()

            ClientRustModule.Client.customize -> customizeModuleDoc()

            ClientRustModule.config -> strDoc("Configuration for $serviceName.")

            ClientRustModule.Config.endpoint -> strDoc("Types needed to configure endpoint resolution.")

            ClientRustModule.Config.retry -> strDoc("Retry configuration.")

            ClientRustModule.Config.timeout -> strDoc("Timeout configuration.")

            ClientRustModule.Config.interceptors -> strDoc("Types needed to implement [`Interceptor`](crate::config::Interceptor).")

codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/endpoint/EndpointConfigCustomization.kt

+5 −3
Original line number Diff line number Diff line
@@ -19,7 +19,7 @@ import software.amazon.smithy.rust.codegen.core.smithy.RuntimeType.Companion.pre 
 * Customization which injects an Endpoints 2.0 Endpoint Resolver into the service config struct

 */

internal class EndpointConfigCustomization(

    codegenContext: ClientCodegenContext,

    private val codegenContext: ClientCodegenContext,

    private val typesGenerator: EndpointTypesGenerator,

) :

    ConfigCustomization() {
@@ -86,6 +86,8 @@ internal class EndpointConfigCustomization( 
                ServiceConfig.BuilderImpl -> {

                    // if there are no rules, we don't generate a default resolver—we need to also suppress those docs.

                    val defaultResolverDocs = if (typesGenerator.defaultResolver() != null) {

                        val endpointModule = ClientRustModule.endpoint(codegenContext).fullyQualifiedPath()

                            .replace("crate::", "$moduleUseName::")

                        """

                        ///

                        /// When unset, the client will used a generated endpoint resolver based on the endpoint resolution
@@ -94,7 +96,7 @@ internal class EndpointConfigCustomization( 
                        /// ## Examples

                        /// ```no_run

                        /// use aws_smithy_http::endpoint;

                        /// use $moduleUseName::endpoint::{Params as EndpointParams, DefaultResolver};

                        /// use $endpointModule::{Params as EndpointParams, DefaultResolver};

                        /// /// Endpoint resolver which adds a prefix to the generated endpoint

                        /// ##[derive(Debug)]

                        /// struct PrefixResolver {
@@ -193,7 +195,7 @@ internal class EndpointConfigCustomization( 
                        }

                    } else {

                        val alwaysFailsResolver =

                            RuntimeType.forInlineFun("MissingResolver", ClientRustModule.Endpoint) {

                            RuntimeType.forInlineFun("MissingResolver", ClientRustModule.endpoint(codegenContext)) {

                                rustTemplate(

                                    """

                                    ##[derive(Debug)]

codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/endpoint/EndpointTypesGenerator.kt

+3 −3
Original line number Diff line number Diff line
@@ -40,10 +40,10 @@ class EndpointTypesGenerator( 
        }

    }



    fun paramsStruct(): RuntimeType = EndpointParamsGenerator(params).paramsStruct()

    fun paramsBuilder(): RuntimeType = EndpointParamsGenerator(params).paramsBuilder()

    fun paramsStruct(): RuntimeType = EndpointParamsGenerator(codegenContext, params).paramsStruct()

    fun paramsBuilder(): RuntimeType = EndpointParamsGenerator(codegenContext, params).paramsBuilder()

    fun defaultResolver(): RuntimeType? =

        rules?.let { EndpointResolverGenerator(stdlib, runtimeConfig).defaultEndpointResolver(it) }

        rules?.let { EndpointResolverGenerator(codegenContext, stdlib).defaultEndpointResolver(it) }



    fun testGenerator(): Writable =

        defaultResolver()?.let {

codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/endpoint/EndpointsDecorator.kt

+3 −3
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ import software.amazon.smithy.rust.codegen.client.smithy.ClientRustModule 
import software.amazon.smithy.rust.codegen.client.smithy.customize.ClientCodegenDecorator

import software.amazon.smithy.rust.codegen.client.smithy.endpoint.generators.CustomRuntimeFunction

import software.amazon.smithy.rust.codegen.client.smithy.endpoint.generators.EndpointParamsGenerator

import software.amazon.smithy.rust.codegen.client.smithy.endpoint.generators.EndpointTests

import software.amazon.smithy.rust.codegen.client.smithy.endpoint.generators.endpointTestsModule

import software.amazon.smithy.rust.codegen.client.smithy.endpoint.rulesgen.SmithyEndpointsStdLib

import software.amazon.smithy.rust.codegen.client.smithy.generators.OperationCustomization

import software.amazon.smithy.rust.codegen.client.smithy.generators.OperationSection
@@ -134,8 +134,8 @@ class EndpointsDecorator : ClientCodegenDecorator { 


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

        val generator = EndpointTypesGenerator.fromContext(codegenContext)

        rustCrate.withModule(ClientRustModule.Endpoint) {

            withInlineModule(EndpointTests, rustCrate.moduleDocProvider) {

        rustCrate.withModule(ClientRustModule.endpoint(codegenContext)) {

            withInlineModule(endpointTestsModule(codegenContext), rustCrate.moduleDocProvider) {

                generator.testGenerator()(this)

            }

        }

codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/endpoint/generators/EndpointParamsGenerator.kt

+11 −8
Original line number Diff line number Diff line
@@ -8,6 +8,7 @@ package software.amazon.smithy.rust.codegen.client.smithy.endpoint.generators 
import software.amazon.smithy.rulesengine.language.eval.Value

import software.amazon.smithy.rulesengine.language.syntax.Identifier

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

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.endpoint.memberName

import software.amazon.smithy.rust.codegen.client.smithy.endpoint.rustName
@@ -37,12 +38,12 @@ import software.amazon.smithy.rust.codegen.core.util.dq 
import software.amazon.smithy.rust.codegen.core.util.orNull



// internals contains the actual resolver function

val EndpointImpl = RustModule.private("internals", parent = ClientRustModule.Endpoint)

fun endpointImplModule(codegenContext: ClientCodegenContext) = RustModule.private("internals", parent = ClientRustModule.endpoint(codegenContext))



val EndpointTests = RustModule.new(

fun endpointTestsModule(codegenContext: ClientCodegenContext) = RustModule.new(

    "test",

    visibility = Visibility.PRIVATE,

    parent = ClientRustModule.Endpoint,

    parent = ClientRustModule.endpoint(codegenContext),

    inline = true,

    documentationOverride = "",

).cfgTest()
@@ -108,22 +109,24 @@ val EndpointStdLib = RustModule.private("endpoint_lib") 
 *  ```

 */



internal class EndpointParamsGenerator(private val parameters: Parameters) {



internal class EndpointParamsGenerator(

    private val codegenContext: ClientCodegenContext,

    private val parameters: Parameters,

) {

    companion object {

        fun memberName(parameterName: String) = Identifier.of(parameterName).rustName()

        fun setterName(parameterName: String) = "set_${memberName(parameterName)}"

    }



    fun paramsStruct(): RuntimeType = RuntimeType.forInlineFun("Params", ClientRustModule.Endpoint) {

    fun paramsStruct(): RuntimeType = RuntimeType.forInlineFun("Params", ClientRustModule.endpoint(codegenContext)) {

        generateEndpointsStruct(this)

    }



    internal fun paramsBuilder(): RuntimeType = RuntimeType.forInlineFun("ParamsBuilder", ClientRustModule.Endpoint) {

    internal fun paramsBuilder(): RuntimeType = RuntimeType.forInlineFun("ParamsBuilder", ClientRustModule.endpoint(codegenContext)) {

        generateEndpointParamsBuilder(this)

    }



    private fun paramsError(): RuntimeType = RuntimeType.forInlineFun("InvalidParams", ClientRustModule.Endpoint) {

    private fun paramsError(): RuntimeType = RuntimeType.forInlineFun("InvalidParams", ClientRustModule.endpoint(codegenContext)) {

        rust(

            """

            /// An error that occurred during endpoint resolution