Unverified Commit 5970ef77 authored by John DiSanti's avatar John DiSanti Committed by GitHub
Browse files

Break up `RustCodegenDecorator` (#2099) 

This change creates `ClientCodegenDecorator` and
`ServerCodegenDecorator` in `codegen-client` and `codegen-server`
respectively to replace `RustCodegenDecorator`. Client/server
equivalents are created to replace `CombinedCodegenDecorator` as well.

This eliminates the need for the `supportsCodegenContext` method since
the decorator interface is no longer generic, so the `ServiceLoader` is
now powerful enough to differentiate.

The largest benefit, however, is that now clients and servers can have
separate customizations.
parent 2480d81b

CHANGELOG.next.toml

+19 −1
Original line number Diff line number Diff line
@@ -10,3 +10,21 @@ 
# references = ["smithy-rs#920"]

# meta = { "breaking" = false, "tada" = false, "bug" = false, "target" = "client | server | all"}

# author = "rcoh"



[[smithy-rs]]

message = "The Rust client codegen plugin is now called `rust-client-codegen` instead of `rust-codegen`. Be sure to update your `smithy-build.json` files to refer to the correct plugin name."

references = ["smithy-rs#2099"]

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

author = "jdisanti"



[[smithy-rs]]

message = "Client codegen plugins need to define a service named `software.amazon.smithy.rust.codegen.client.smithy.customize.ClientCodegenDecorator` (this is the new file name for the plugin definition in `resources/META-INF/services`)."

references = ["smithy-rs#2099"]

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

author = "jdisanti"



[[smithy-rs]]

message = "Server codegen plugins need to define a service named `software.amazon.smithy.rust.codegen.server.smithy.customize.ServerCodegenDecorator` (this is the new file name for the plugin definition in `resources/META-INF/services`)."

references = ["smithy-rs#2099"]

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

author = "jdisanti"

aws/sdk-adhoc-test/build.gradle.kts

+1 −1
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ val smithyVersion: String by project 
val defaultRustDocFlags: String by project

val properties = PropertyRetriever(rootProject, project)



val pluginName = "rust-codegen"

val pluginName = "rust-client-codegen"

val workingDirUnderBuildDir = "smithyprojections/sdk-adhoc-test/"



configure<software.amazon.smithy.gradle.SmithyExtension> {

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

+4 −5
Original line number Diff line number Diff line
@@ -5,11 +5,10 @@ 


package software.amazon.smithy.rustsdk



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

import software.amazon.smithy.rust.codegen.client.smithy.customizations.DocsRsMetadataDecorator

import software.amazon.smithy.rust.codegen.client.smithy.customizations.DocsRsMetadataSettings

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

import software.amazon.smithy.rust.codegen.client.smithy.generators.protocol.ClientProtocolGenerator

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

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

import software.amazon.smithy.rustsdk.customize.apigateway.ApiGatewayDecorator

import software.amazon.smithy.rustsdk.customize.auth.DisabledAuthDecorator

import software.amazon.smithy.rustsdk.customize.ec2.Ec2Decorator
@@ -18,7 +17,7 @@ import software.amazon.smithy.rustsdk.customize.route53.Route53Decorator 
import software.amazon.smithy.rustsdk.customize.s3.S3Decorator

import software.amazon.smithy.rustsdk.customize.sts.STSDecorator



val DECORATORS = listOf(

val DECORATORS: List<ClientCodegenDecorator> = listOf(

    // General AWS Decorators

    CredentialsProviderDecorator(),

    RegionDecorator(),
@@ -50,7 +49,7 @@ val DECORATORS = listOf( 
    DocsRsMetadataDecorator(DocsRsMetadataSettings(targets = listOf("x86_64-unknown-linux-gnu"), allFeatures = true)),

)



class AwsCodegenDecorator : CombinedCodegenDecorator<ClientProtocolGenerator, ClientCodegenContext>(DECORATORS) {

class AwsCodegenDecorator : CombinedClientCodegenDecorator(DECORATORS) {

    override val name: String = "AwsSdkCodegenDecorator"

    override val order: Byte = -1

}

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

+2 −6
Original line number Diff line number Diff line
@@ -12,10 +12,9 @@ import software.amazon.smithy.model.node.ObjectNode 
import software.amazon.smithy.model.node.StringNode

import software.amazon.smithy.model.shapes.OperationShape

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

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

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

import software.amazon.smithy.rust.codegen.client.smithy.generators.config.ConfigCustomization

import software.amazon.smithy.rust.codegen.client.smithy.generators.config.ServiceConfig

import software.amazon.smithy.rust.codegen.client.smithy.generators.protocol.ClientProtocolGenerator

import software.amazon.smithy.rust.codegen.core.rustlang.CargoDependency

import software.amazon.smithy.rust.codegen.core.rustlang.RustModule

import software.amazon.smithy.rust.codegen.core.rustlang.RustWriter
@@ -39,7 +38,7 @@ import software.amazon.smithy.rust.codegen.core.util.expectTrait 
import software.amazon.smithy.rust.codegen.core.util.orNull

import kotlin.io.path.readText



class AwsEndpointDecorator : RustCodegenDecorator<ClientProtocolGenerator, ClientCodegenContext> {

class AwsEndpointDecorator : ClientCodegenDecorator {

    override val name: String = "AwsEndpoint"

    override val order: Byte = 0
@@ -83,9 +82,6 @@ class AwsEndpointDecorator : RustCodegenDecorator<ClientProtocolGenerator, Clien 
    ): List<LibRsCustomization> {

        return baseCustomizations + PubUseEndpoint(codegenContext.runtimeConfig)

    }



    override fun supportsCodegenContext(clazz: Class<out CodegenContext>): Boolean =

        clazz.isAssignableFrom(ClientCodegenContext::class.java)

}



class EndpointConfigCustomization(

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

+2 −8
Original line number Diff line number Diff line
@@ -8,12 +8,10 @@ package software.amazon.smithy.rustsdk 
import software.amazon.smithy.model.node.Node

import software.amazon.smithy.model.node.ObjectNode

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

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

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.endpoint.generators.CustomRuntimeFunction

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

import software.amazon.smithy.rust.codegen.client.smithy.generators.protocol.ClientProtocolGenerator

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

import kotlin.io.path.readText



/**
@@ -23,15 +21,11 @@ import kotlin.io.path.readText 
 *

 * For test purposes, [awsStandardLib] can be used directly with a manually supplied partitions.json

 */

class AwsEndpointsStdLib() : RustCodegenDecorator<ClientProtocolGenerator, ClientCodegenContext> {

class AwsEndpointsStdLib() : ClientCodegenDecorator {

    private var partitionsCache: ObjectNode? = null

    override val name: String = "AwsEndpointsStdLib"

    override val order: Byte = 0



    override fun supportsCodegenContext(clazz: Class<out CodegenContext>): Boolean {

        return clazz.isAssignableFrom(ClientCodegenContext::class.java)

    }



    private fun partitionMetadata(sdkSettings: SdkSettings): ObjectNode {

        if (partitionsCache == null) {

            val partitionsJson = when (val path = sdkSettings.partitionsConfigPath) {