feat: UserAgent v2.1 #1690
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| // | ||
| // Copyright Amazon.com Inc. or its affiliates. | ||
| // All Rights Reserved. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
|
|
||
| import ClientRuntime | ||
| import class Smithy.Context | ||
| import struct Smithy.AttributeKey | ||
|
|
||
| struct BusinessMetrics { | ||
| // Mapping of human readable feature ID to the corresponding metric value | ||
| let features: [String: String] | ||
|
|
||
| init( | ||
| config: UserAgentValuesFromConfig, | ||
| context: Context | ||
| ) { | ||
| setFlagsIntoContext(config: config, context: context) | ||
|
There was a problem hiding this comment. Looks at values in config and context, and saves flags to |
||
| self.features = context.businessMetrics | ||
|
There was a problem hiding this comment. Takes the updated |
||
| } | ||
| } | ||
|
|
||
| extension BusinessMetrics: CustomStringConvertible { | ||
| var description: String { | ||
| var commaSeparatedMetricValues = features.values.sorted().joined(separator: ",") | ||
| // Cut last metric value from string until the | ||
| // comma-separated list of metric values are at or below 1024 bytes in size | ||
| if commaSeparatedMetricValues.lengthOfBytes(using: .ascii) > 1024 { | ||
| while commaSeparatedMetricValues.lengthOfBytes(using: .ascii) > 1024 { | ||
| commaSeparatedMetricValues = commaSeparatedMetricValues.substringBeforeLast(",") | ||
| } | ||
| } | ||
|
Comment on lines
+30
to
+34
There was a problem hiding this comment. SEP states that the string value of business metrics (comma-separated metric values without spaces) cannot exceed 1024 bytes, and last value in the string must be removed until size requirement is met. |
||
| return "m/\(commaSeparatedMetricValues)" | ||
| } | ||
| } | ||
|
|
||
| private extension String { | ||
| func substringBeforeLast(_ separator: String) -> String { | ||
| if let range = self.range(of: separator, options: .backwards) { | ||
| return String(self[..<range.lowerBound]) | ||
| } else { | ||
| return self | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public extension Context { | ||
| var businessMetrics: Dictionary<String, String> { | ||
| get { attributes.get(key: businessMetricsKey) ?? [:] } | ||
| set(newPair) { | ||
| var combined = businessMetrics | ||
| combined.merge(newPair) { (current, new) in new } | ||
| attributes.set(key: businessMetricsKey, value: combined) | ||
|
Comment on lines
+53
to
+55
There was a problem hiding this comment. Adds a new entry to existing dictionary, overriding with new entry's value if existing dictionary already has an entry with the same key |
||
| } | ||
| } | ||
| } | ||
|
|
||
| public let businessMetricsKey = AttributeKey<Dictionary<String, String>>(name: "BusinessMetrics") | ||
|
|
||
| /* List of readable "feature ID" to "metric value"; last updated on 08/19/2024 | ||
| [Feature ID] [Metric Value] [Flag Supported] | ||
| "RESOURCE_MODEL" : "A" : | ||
| "WAITER" : "B" : | ||
| "PAGINATOR" : "C" : | ||
| "RETRY_MODE_LEGACY" : "D" : Y | ||
| "RETRY_MODE_STANDARD" : "E" : Y | ||
| "RETRY_MODE_ADAPTIVE" : "F" : Y | ||
| "S3_TRANSFER" : "G" : | ||
| "S3_CRYPTO_V1N" : "H" : | ||
| "S3_CRYPTO_V2" : "I" : | ||
| "S3_EXPRESS_BUCKET" : "J" : | ||
| "S3_ACCESS_GRANTS" : "K" : | ||
| "GZIP_REQUEST_COMPRESSION" : "L" : | ||
| "PROTOCOL_RPC_V2_CBOR" : "M" : | ||
| "ENDPOINT_OVERRIDE" : "N" : Y | ||
| "ACCOUNT_ID_ENDPOINT" : "O" : | ||
| "ACCOUNT_ID_MODE_PREFERRED" : "P" : | ||
| "ACCOUNT_ID_MODE_DISABLED" : "Q" : | ||
| "ACCOUNT_ID_MODE_REQUIRED" : "R" : | ||
| "SIGV4A_SIGNING" : "S" : Y | ||
| "RESOLVED_ACCOUNT_ID" : "T" : | ||
| */ | ||
|
Comment on lines
+62
to
+84
There was a problem hiding this comment. This is to be updated each time we support new flags |
||
| fileprivate func setFlagsIntoContext( | ||
| config: UserAgentValuesFromConfig, | ||
| context: Context | ||
| ) { | ||
| // Handle D, E, F | ||
| switch config.awsRetryMode { | ||
| case .legacy: | ||
| context.businessMetrics = ["RETRY_MODE_LEGACY": "D"] | ||
| case .standard: | ||
| context.businessMetrics = ["RETRY_MODE_STANDARD": "E"] | ||
| case .adaptive: | ||
| context.businessMetrics = ["RETRY_MODE_ADAPTIVE": "F"] | ||
| } | ||
| // Handle N | ||
| if let endpoint = config.endpoint, !endpoint.isEmpty { | ||
| context.businessMetrics = ["ENDPOINT_OVERRIDE": "N"] | ||
| } | ||
| // Handle S | ||
| if context.selectedAuthScheme?.schemeID == "aws.auth#sigv4a" { | ||
| context.businessMetrics = ["SIGV4A_SIGNING": "S"] | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| // | ||
| // Copyright Amazon.com Inc. or its affiliates. | ||
| // All Rights Reserved. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
|
|
||
| import XCTest | ||
| import ClientRuntime | ||
| @testable import AWSClientRuntime | ||
| import SmithyRetriesAPI | ||
| import SmithyHTTPAuthAPI | ||
| import SmithyIdentity | ||
| import SmithyRetriesAPI | ||
| import Smithy | ||
|
|
||
| class BusinessMetricsTests: XCTestCase { | ||
| var context: Context! | ||
|
|
||
| override func setUp() async throws { | ||
| context = Context(attributes: Attributes()) | ||
| } | ||
|
|
||
| func test_business_metrics_section_truncation() { | ||
| context.businessMetrics = ["SHORT_FILLER": "A"] | ||
| let longMetricValue = String(repeating: "F", count: 1025) | ||
| context.businessMetrics = ["LONG_FILLER": longMetricValue] | ||
| let userAgent = AWSUserAgentMetadata.fromConfigAndContext( | ||
| serviceID: "test", | ||
| version: "1.0", | ||
| config: UserAgentValuesFromConfig(appID: nil, endpoint: nil, awsRetryMode: .standard), | ||
| context: context | ||
| ) | ||
| // Assert values in context match with values assigned to user agent | ||
| XCTAssertEqual(userAgent.businessMetrics?.features, context.businessMetrics) | ||
| // Assert string gets truncated successfully | ||
| let expectedTruncatedString = "m/A,E" | ||
| XCTAssertEqual(userAgent.businessMetrics?.description, expectedTruncatedString) | ||
| } | ||
|
|
||
| func test_multiple_flags_in_context() { | ||
| context.businessMetrics = ["FIRST": "A"] | ||
| context.businessMetrics = ["SECOND": "B"] | ||
| context.setSelectedAuthScheme(SelectedAuthScheme( // S | ||
| schemeID: "aws.auth#sigv4a", | ||
| identity: nil, | ||
| signingProperties: nil, | ||
| signer: nil | ||
| )) | ||
| let userAgent = AWSUserAgentMetadata.fromConfigAndContext( | ||
| serviceID: "test", | ||
| version: "1.0", | ||
| config: UserAgentValuesFromConfig(appID: nil, endpoint: "test-endpoint", awsRetryMode: .adaptive), | ||
| context: context | ||
| ) | ||
| // F comes from retry mode being adaptive & N comes from endpoint override | ||
| let expectedString = "m/A,B,F,N,S" | ||
| XCTAssertEqual(userAgent.businessMetrics?.description, expectedString) | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Delay when the
AWSUserAgentMetadatais initialized, from middleware init to middleware execution. This ensures we have the latest and all values we need from context to populate the user agent header.