chore: update environment variable references to use AWS_SDK_UA_APP_ID #934
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.
Issue number: #933
Summary
Changes
This pull request introduces a new constant,
AWS_SDK_UA_APP_ID
, to represent a unique application ID for the User-Agent header, replacing the previous use ofAWS_EXECUTION_ENV
in the codebase. The changes involve updating constants, interfaces, implementations, and test cases to reflect this new environment variable.Key Changes:
Core Library Updates:
AWSSdkUAAppId
inConstants.cs
to represent theAWS_SDK_UA_APP_ID
environment variable. This constant is used throughout the library to replaceAWS_EXECUTION_ENV
.SetExecutionEnvironment
method inIPowertoolsConfigurations
andIPowertoolsEnvironment
interfaces to useAWS_SDK_UA_APP_ID
. [1] [2]SetExecutionEnvironment
implementation inPowertoolsEnvironment.cs
to set and retrieve theAWS_SDK_UA_APP_ID
environment variable instead ofAWS_EXECUTION_ENV
.Test Updates:
BatchProcessingInternalTests.cs
,PowertoolsEnvironmentTest.cs
,IdempotentAspectTests.cs
,PowertoolsLoggerTest.cs
,MetricsTests.cs
,XRayRecorderTests.cs
) to validate behavior usingAWS_SDK_UA_APP_ID
instead ofAWS_EXECUTION_ENV
. [1] [2] [3] [4] [5] [6]Code Quality:
InconsistentNaming
rule inConstants.cs
to accommodate naming conventions for constants.User experience
Checklist
Please leave checklist items unchecked if they do not apply to your change.
Is this a breaking change?
RFC issue number:
Checklist:
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.