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.

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

fix: outdated business metric ids #1113

Merged
merged 5 commits into from
Jul 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ object RuntimeTypes {

object BusinessMetrics : RuntimeTypePackage(KotlinDependency.CORE, "businessmetrics") {
val AccountIdBasedEndpointAccountId = symbol("AccountIdBasedEndpointAccountId")
val ServiceEndpointOverride = symbol("ServiceEndpointOverride")
val EndpointOverride = symbol("EndpointOverride")
val emitBusinessMetric = symbol("emitBusinessMetric")
val SmithyBusinessMetric = symbol("SmithyBusinessMetric")
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -173,8 +173,8 @@ class DefaultEndpointProviderGenerator(
write("),")

val hasAccountIdBasedEndpoint = "accountId" in endpointInfo.params
val hasServiceEndpointOverride = "endpoint" in endpointInfo.params
val needAdditionalEndpointProperties = hasAccountIdBasedEndpoint || hasServiceEndpointOverride
val hasEndpointOverride = "endpoint" in endpointInfo.params
val needAdditionalEndpointProperties = hasAccountIdBasedEndpoint || hasEndpointOverride

if (rule.endpoint.headers.isNotEmpty()) {
withBlock("headers = #T {", "},", RuntimeTypes.Http.Headers) {
Expand Down Expand Up @@ -211,8 +211,8 @@ class DefaultEndpointProviderGenerator(
if (hasAccountIdBasedEndpoint) {
writer.write("#T to params.accountId", RuntimeTypes.Core.BusinessMetrics.AccountIdBasedEndpointAccountId)
}
if (hasServiceEndpointOverride) {
writer.write("#T to true", RuntimeTypes.Core.BusinessMetrics.ServiceEndpointOverride)
if (hasEndpointOverride) {
writer.write("#T to true", RuntimeTypes.Core.BusinessMetrics.EndpointOverride)
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ class DefaultEndpointProviderTestGenerator(
writer.withBlock(
"if (actual.attributes.contains(#T) || actual.attributes.contains(#T)) {",
"} else { assertEquals(expected, actual) }",
RuntimeTypes.Core.BusinessMetrics.ServiceEndpointOverride,
RuntimeTypes.Core.BusinessMetrics.EndpointOverride,
RuntimeTypes.Core.BusinessMetrics.AccountIdBasedEndpointAccountId,
) {
writer.write(
Expand All @@ -79,7 +79,7 @@ class DefaultEndpointProviderTestGenerator(
)
writer.write(
"newActualAttributes.remove(#T)",
RuntimeTypes.Core.BusinessMetrics.ServiceEndpointOverride,
RuntimeTypes.Core.BusinessMetrics.EndpointOverride,
)
writer.write(
"newActualAttributes.remove(#T)",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ class DefaultEndpointProviderGeneratorTest {
Url.parse("https://$moneySign{params.accountId}.$moneySign{params.endpoint}"),
attributes = attributesOf {
AccountIdBasedEndpointAccountId to params.accountId
ServiceEndpointOverride to true
EndpointOverride to true
},
)
"""
Expand All @@ -303,7 +303,7 @@ class DefaultEndpointProviderGeneratorTest {
return Endpoint(
Url.parse("https://$moneySign{params.endpoint}"),
attributes = attributesOf {
ServiceEndpointOverride to true
EndpointOverride to true
},
)
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -343,13 +343,13 @@ internal class InterceptorExecutor<I, O>(
) {
if (modifiedRequest.url != request.url) {
if (
context.executionContext.containsBusinessMetric(SmithyBusinessMetric.ACCOUNT_ID_BASED_ENDPOINT) &&
context.executionContext.containsBusinessMetric(SmithyBusinessMetric.ACCOUNT_ID_ENDPOINT) &&
!modifiedRequest.url.toString().contains(context.executionContext.attributes[AccountIdBasedEndpointAccountId])
) {
context.executionContext.removeBusinessMetric(SmithyBusinessMetric.ACCOUNT_ID_BASED_ENDPOINT)
context.executionContext.removeBusinessMetric(SmithyBusinessMetric.ACCOUNT_ID_ENDPOINT)
}
if (context.executionContext.containsBusinessMetric(SmithyBusinessMetric.SERVICE_ENDPOINT_OVERRIDE)) {
context.executionContext.removeBusinessMetric(SmithyBusinessMetric.SERVICE_ENDPOINT_OVERRIDE)
if (context.executionContext.containsBusinessMetric(SmithyBusinessMetric.ENDPOINT_OVERRIDE)) {
context.executionContext.removeBusinessMetric(SmithyBusinessMetric.ENDPOINT_OVERRIDE)
}
}
}
Expand Down
10 changes: 7 additions & 3 deletions runtime/runtime-core/api/runtime-core.api
Original file line number Diff line number Diff line change
Expand Up @@ -86,18 +86,22 @@ public final class aws/smithy/kotlin/runtime/businessmetrics/BusinessMetricsUtil
public static final fun emitBusinessMetric (Laws/smithy/kotlin/runtime/operation/ExecutionContext;Laws/smithy/kotlin/runtime/businessmetrics/BusinessMetric;)V
public static final fun getAccountIdBasedEndpointAccountId ()Laws/smithy/kotlin/runtime/collections/AttributeKey;
public static final fun getBusinessMetrics ()Laws/smithy/kotlin/runtime/collections/AttributeKey;
public static final fun getServiceEndpointOverride ()Laws/smithy/kotlin/runtime/collections/AttributeKey;
public static final fun getEndpointOverride ()Laws/smithy/kotlin/runtime/collections/AttributeKey;
public static final fun removeBusinessMetric (Laws/smithy/kotlin/runtime/operation/ExecutionContext;Laws/smithy/kotlin/runtime/businessmetrics/BusinessMetric;)V
}

public final class aws/smithy/kotlin/runtime/businessmetrics/SmithyBusinessMetric : java/lang/Enum, aws/smithy/kotlin/runtime/businessmetrics/BusinessMetric {
public static final field ACCOUNT_ID_BASED_ENDPOINT Laws/smithy/kotlin/runtime/businessmetrics/SmithyBusinessMetric;
public static final field ACCOUNT_ID_ENDPOINT Laws/smithy/kotlin/runtime/businessmetrics/SmithyBusinessMetric;
public static final field ACCOUNT_ID_MODE_DISABLED Laws/smithy/kotlin/runtime/businessmetrics/SmithyBusinessMetric;
public static final field ACCOUNT_ID_MODE_PREFERRED Laws/smithy/kotlin/runtime/businessmetrics/SmithyBusinessMetric;
public static final field ACCOUNT_ID_MODE_REQUIRED Laws/smithy/kotlin/runtime/businessmetrics/SmithyBusinessMetric;
public static final field ENDPOINT_OVERRIDE Laws/smithy/kotlin/runtime/businessmetrics/SmithyBusinessMetric;
public static final field GZIP_REQUEST_COMPRESSION Laws/smithy/kotlin/runtime/businessmetrics/SmithyBusinessMetric;
public static final field PAGINATOR Laws/smithy/kotlin/runtime/businessmetrics/SmithyBusinessMetric;
public static final field PROTOCOL_RPC_V2_CBOR Laws/smithy/kotlin/runtime/businessmetrics/SmithyBusinessMetric;
public static final field RESOLVED_ACCOUNT_ID Laws/smithy/kotlin/runtime/businessmetrics/SmithyBusinessMetric;
public static final field RETRY_MODE_ADAPTIVE Laws/smithy/kotlin/runtime/businessmetrics/SmithyBusinessMetric;
public static final field RETRY_MODE_STANDARD Laws/smithy/kotlin/runtime/businessmetrics/SmithyBusinessMetric;
public static final field SERVICE_ENDPOINT_OVERRIDE Laws/smithy/kotlin/runtime/businessmetrics/SmithyBusinessMetric;
public static final field SIGV4A_SIGNING Laws/smithy/kotlin/runtime/businessmetrics/SmithyBusinessMetric;
public static final field WAITER Laws/smithy/kotlin/runtime/businessmetrics/SmithyBusinessMetric;
public static fun getEntries ()Lkotlin/enums/EnumEntries;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public val AccountIdBasedEndpointAccountId: AttributeKey<String> = AttributeKey(
* If an endpoint is "service endpoint override" based
*/
@InternalApi
public val ServiceEndpointOverride: AttributeKey<Boolean> = AttributeKey("aws.smithy.kotlin#ServiceEndpointOverride")
public val EndpointOverride: AttributeKey<Boolean> = AttributeKey("aws.smithy.kotlin#EndpointOverride")

/**
* Emit a business metric to the execution context attributes
Expand Down Expand Up @@ -74,7 +74,11 @@ public enum class SmithyBusinessMetric(public override val identifier: String) :
RETRY_MODE_ADAPTIVE("F"),
GZIP_REQUEST_COMPRESSION("L"),
PROTOCOL_RPC_V2_CBOR("M"),
SERVICE_ENDPOINT_OVERRIDE("N"),
ACCOUNT_ID_BASED_ENDPOINT("O"),
SIGV4A_SIGNING("P"),
ENDPOINT_OVERRIDE("N"),
ACCOUNT_ID_ENDPOINT("O"),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we also emit the new ACCOUNT_ID_MODE_PREFERRED, ACCOUNT_ID_MODE_DISABLED, ACCOUNT_ID_MODE_REQUIRED metrics?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, we can add that

ACCOUNT_ID_MODE_PREFERRED("P"), // TODO: Emit this metric
ACCOUNT_ID_MODE_DISABLED("Q"), // TODO: Emit this metric
ACCOUNT_ID_MODE_REQUIRED("R"), // TODO: Emit this metric
SIGV4A_SIGNING("S"),
RESOLVED_ACCOUNT_ID("T"), // TODO: Emit this metric
}
Loading