feat: UserAgent v2.1 #1690
feat: UserAgent v2.1 #1690
Conversation
…puted property, utility function for grabbing flags from config / context and saving them into context.businessMetrics.
…tMiddlewrae initialization code, to the runtime UserAgentMiddleware code. This delays user agent struct initialization to right before the request is sent, and is done because we need access to the last-minute values in the context right before the request is sent, in order to grab all features used in request flow and put them in the business metrics section of the user agent.
…efactor fromConfig() initializer wrapper to fromConfigAndContext(), now that business metrics needs values saved in context as well.
… relevant values from config. Add unit tests for BusinessMetrics.
| @@ -15,24 +15,34 @@ public struct UserAgentMiddleware<OperationStackInput, OperationStackOutput> { | |||
| private let X_AMZ_USER_AGENT: String = "x-amz-user-agent" | |||
There was a problem hiding this comment.
Delay when the AWSUserAgentMetadata is 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.
| let awsUserAgentString = AWSUserAgentMetadata.fromConfigAndContext( | ||
| serviceID: serviceID, | ||
| version: version, | ||
| config: UserAgentValuesFromConfig(config: config), |
There was a problem hiding this comment.
UserAgentValuesFromConfig is a container for subset of config values in the original config. This makes testing much easier + small benefit of not passing entire config object again.
| @@ -6,6 +6,7 @@ | |||
| // | |||
There was a problem hiding this comment.
Replace configMetadata and featureMetadata with the new businessMetrics.
| self.frameworkMetadata = frameworkMetadata | ||
| } | ||
|
|
||
| public static func fromConfig( | ||
| public static func fromConfigAndContext( |
There was a problem hiding this comment.
Now we need context as well, since business metrics get set in context by middlewares (interceptors).
| frameworkMetadata: frameworkMetadata | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| public class UserAgentValuesFromConfig { |
There was a problem hiding this comment.
This is a container for config values that we need for user agent header.
| if commaSeparatedMetricValues.lengthOfBytes(using: .ascii) > 1024 { | ||
| while commaSeparatedMetricValues.lengthOfBytes(using: .ascii) > 1024 { | ||
| commaSeparatedMetricValues = commaSeparatedMetricValues.substringBeforeLast(",") | ||
| } | ||
| } |
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.
| 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 context.businessMetrics.
| context: Context | ||
| ) { | ||
| setFlagsIntoContext(config: config, context: context) | ||
| self.features = context.businessMetrics |
There was a problem hiding this comment.
Takes the updated context.businessMetrics from line directly above this and sets it to features.
| /* 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" : | ||
| */ |
There was a problem hiding this comment.
This is to be updated each time we support new flags
| var combined = businessMetrics | ||
| combined.merge(newPair) { (current, new) in new } | ||
| attributes.set(key: businessMetricsKey, value: combined) |
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
Issue #
Description of changes
New/existing dependencies impact assessment, if applicable
Conventional Commits
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.