Skip to content

chore: update environment variable references to use AWS_SDK_UA_APP_ID #934

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

Open
wants to merge 10 commits into
base: develop
Choose a base branch
from
Open
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
15 changes: 15 additions & 0 deletions libraries/AWS.Lambda.Powertools.sln
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AWS.Lambda.Powertools.Kafka
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AWS.Lambda.Powertools.Kafka.Protobuf", "src\AWS.Lambda.Powertools.Kafka.Protobuf\AWS.Lambda.Powertools.Kafka.Protobuf.csproj", "{B640DB80-C982-407B-A2EC-CD29AC77DDB8}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AWS.Lambda.Powertools.SourceGenerator.Tests", "tests\AWS.Lambda.Powertools.SourceGenerator.Tests\AWS.Lambda.Powertools.SourceGenerator.Tests.csproj", "{D94F60B1-B65B-451B-BFB4-EAC63881B17E}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -688,6 +690,18 @@ Global
{B640DB80-C982-407B-A2EC-CD29AC77DDB8}.Release|x64.Build.0 = Release|Any CPU
{B640DB80-C982-407B-A2EC-CD29AC77DDB8}.Release|x86.ActiveCfg = Release|Any CPU
{B640DB80-C982-407B-A2EC-CD29AC77DDB8}.Release|x86.Build.0 = Release|Any CPU
{D94F60B1-B65B-451B-BFB4-EAC63881B17E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{D94F60B1-B65B-451B-BFB4-EAC63881B17E}.Debug|Any CPU.Build.0 = Debug|Any CPU
{D94F60B1-B65B-451B-BFB4-EAC63881B17E}.Debug|x64.ActiveCfg = Debug|Any CPU
{D94F60B1-B65B-451B-BFB4-EAC63881B17E}.Debug|x64.Build.0 = Debug|Any CPU
{D94F60B1-B65B-451B-BFB4-EAC63881B17E}.Debug|x86.ActiveCfg = Debug|Any CPU
{D94F60B1-B65B-451B-BFB4-EAC63881B17E}.Debug|x86.Build.0 = Debug|Any CPU
{D94F60B1-B65B-451B-BFB4-EAC63881B17E}.Release|Any CPU.ActiveCfg = Release|Any CPU
{D94F60B1-B65B-451B-BFB4-EAC63881B17E}.Release|Any CPU.Build.0 = Release|Any CPU
{D94F60B1-B65B-451B-BFB4-EAC63881B17E}.Release|x64.ActiveCfg = Release|Any CPU
{D94F60B1-B65B-451B-BFB4-EAC63881B17E}.Release|x64.Build.0 = Release|Any CPU
{D94F60B1-B65B-451B-BFB4-EAC63881B17E}.Release|x86.ActiveCfg = Release|Any CPU
{D94F60B1-B65B-451B-BFB4-EAC63881B17E}.Release|x86.Build.0 = Release|Any CPU
EndGlobalSection

GlobalSection(NestedProjects) = preSolution
Expand Down Expand Up @@ -746,5 +760,6 @@ Global
{25F0929B-2E04-4ED6-A0ED-5379A0A755B0} = {73C9B1E5-3893-47E8-B373-17E5F5D7E6F5}
{9E2B8160-3E76-4B33-86AB-DE35A5FCDB1E} = {73C9B1E5-3893-47E8-B373-17E5F5D7E6F5}
{B640DB80-C982-407B-A2EC-CD29AC77DDB8} = {73C9B1E5-3893-47E8-B373-17E5F5D7E6F5}
{D94F60B1-B65B-451B-BFB4-EAC63881B17E} = {1CFF5568-8486-475F-81F6-06105C437528}
EndGlobalSection
EndGlobal
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@
<AssemblyName>AWS.Lambda.Powertools.BatchProcessing</AssemblyName>
<RootNamespace>AWS.Lambda.Powertools.BatchProcessing</RootNamespace>
<IncludeCommonFiles>true</IncludeCommonFiles>
<IncludeExecutionEnvironment>true</IncludeExecutionEnvironment>
</PropertyGroup>
<ItemGroup>
<!-- Package versions are Centrally managed in Directory.Packages.props file -->
<!-- More info https://learn.microsoft.com/en-us/nuget/consume-packages/central-package-management -->
<PackageReference Include="Amazon.Lambda.DynamoDBEvents" />
<PackageReference Include="Amazon.Lambda.KinesisEvents" />
<PackageReference Include="Amazon.Lambda.SQSEvents" />
<PackageReference Include="Microsoft.CodeAnalysis.Common" />
<ProjectReference Include="..\AWS.Lambda.Powertools.Common\AWS.Lambda.Powertools.Common.csproj" Condition="'$(Configuration)'=='Debug'"/>
</ItemGroup>
</Project>
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
using System.Threading;
using System.Threading.Tasks;
using AWS.Lambda.Powertools.BatchProcessing.Exceptions;
using AWS.Lambda.Powertools.Common;

namespace AWS.Lambda.Powertools.BatchProcessing;

Expand All @@ -16,14 +15,6 @@ namespace AWS.Lambda.Powertools.BatchProcessing;
/// <typeparam name="TRecord">Type of batch record.</typeparam>
public abstract class BatchProcessor<TEvent, TRecord> : IBatchProcessor<TEvent, TRecord>
{
/// <summary>
/// Default constructor
/// </summary>
protected BatchProcessor(IPowertoolsConfigurations powertoolsConfigurations)
{
powertoolsConfigurations.SetExecutionEnvironment(this);
}

/// <inheritdoc />
public ProcessingResult<TRecord> ProcessingResult { get; protected set; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@

using System.Collections.Generic;
using Amazon.Lambda.DynamoDBEvents;
using AWS.Lambda.Powertools.Common;

namespace AWS.Lambda.Powertools.BatchProcessing.DynamoDb;

Expand All @@ -33,23 +32,16 @@ public class DynamoDbStreamBatchProcessor : BatchProcessor<DynamoDBEvent, Dynamo
/// The singleton instance of the batch processor.
/// </summary>
public static IDynamoDbStreamBatchProcessor Instance =>
_instance ??= new DynamoDbStreamBatchProcessor(PowertoolsConfigurations.Instance);
_instance ??= new DynamoDbStreamBatchProcessor();


/// <summary>
/// This is the default constructor
/// </summary>
/// <param name="powertoolsConfigurations"></param>
public DynamoDbStreamBatchProcessor(IPowertoolsConfigurations powertoolsConfigurations) : base(powertoolsConfigurations)
{
_instance = this;
}

/// <summary>
/// Need default constructor for when consumers create a custom batch processor
/// </summary>
// ReSharper disable once MemberCanBePrivate.Global
protected DynamoDbStreamBatchProcessor() : this(PowertoolsConfigurations.Instance)
protected DynamoDbStreamBatchProcessor()
{
_instance = this;
}

/// <summary>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
using AWS.Lambda.Powertools.Common;

namespace AWS.Lambda.Powertools.BatchProcessing.Internal
{
public static class EnvWrapper
{
public static void SetExecutionEnvironment()
{
PowertoolsEnvironment.Instance.SetExecutionEnvironment(typeof(EnvWrapper));
}
}
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
using System.Collections.Generic;
using Amazon.Lambda.KinesisEvents;
using AWS.Lambda.Powertools.Common;

namespace AWS.Lambda.Powertools.BatchProcessing.Kinesis;

Expand All @@ -18,25 +17,16 @@ public class KinesisEventBatchProcessor : BatchProcessor<KinesisEvent, KinesisEv
/// The singleton instance of the batch processor.
/// </summary>
public static IKinesisEventBatchProcessor Instance =>
_instance ??= new KinesisEventBatchProcessor(PowertoolsConfigurations.Instance);

/// <summary>
/// This is the default constructor
/// </summary>
/// <param name="powertoolsConfigurations"></param>
public KinesisEventBatchProcessor(IPowertoolsConfigurations powertoolsConfigurations) : base(powertoolsConfigurations)
{
_instance = this;
}
_instance ??= new KinesisEventBatchProcessor();

/// <summary>
/// Need default constructor for when consumers create a custom batch processor
/// </summary>
// ReSharper disable once MemberCanBePrivate.Global
protected KinesisEventBatchProcessor() : this(PowertoolsConfigurations.Instance)
protected KinesisEventBatchProcessor()
{
_instance = this;
}

/// <summary>
/// Return the instance ProcessingResult
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
#if NET8_0_OR_GREATER

using System.Text;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Text;

namespace AWS.Lambda.Powertools.BatchProcessing.SourceGenerators;

/// <summary>
/// Source generator that automatically sets the AWS_SDK_UA_APP_ID environment variable
/// </summary>
[Generator]
public class UASourceGenerator : IIncrementalGenerator
{
/// <summary>
/// Initializes the source generator.
/// </summary>
/// <param name="context"></param>
public void Initialize(IncrementalGeneratorInitializationContext context)
{
context.RegisterPostInitializationOutput(ctx =>
{
var source = """
// <auto-generated />
using System.Runtime.CompilerServices;

namespace AWS.Lambda.Powertools.BatchProcessing.Internal
{
internal static class UAModuleInitializer
{
[ModuleInitializer]
internal static void Initialize()
{
EnvWrapper.SetExecutionEnvironment();
}
}
}
""";
ctx.AddSource("UAModuleInitializer.g.cs", SourceText.From(source, Encoding.UTF8));
});
}
}

#endif
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
using System.Collections.Generic;
using System.Linq;
using Amazon.Lambda.SQSEvents;
using AWS.Lambda.Powertools.Common;

namespace AWS.Lambda.Powertools.BatchProcessing.Sqs;

Expand All @@ -20,22 +19,14 @@ public class SqsBatchProcessor : BatchProcessor<SQSEvent, SQSEvent.SQSMessage>,
/// Gets the instance.
/// </summary>
/// <value>The instance.</value>
public static ISqsBatchProcessor Instance => _instance ??= new SqsBatchProcessor(PowertoolsConfigurations.Instance);

/// <summary>
/// This is the default constructor
/// </summary>
/// <param name="powertoolsConfigurations"></param>
public SqsBatchProcessor(IPowertoolsConfigurations powertoolsConfigurations) : base(powertoolsConfigurations)
{
_instance = this;
}

public static ISqsBatchProcessor Instance => _instance ??= new SqsBatchProcessor();

/// <summary>
/// Need default constructor for when consumers create a custom batch processor
/// </summary>
protected SqsBatchProcessor() : this(PowertoolsConfigurations.Instance)
public SqsBatchProcessor()
{
_instance = this;
}

/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,17 @@

<PropertyGroup>
<!-- Remaining properties are defined in Directory.Build.props -->
<PackageId>AWS.Lambda.Powertools.Common</PackageId>
<Description>Powertools for AWS Lambda (.NET) - Core package.</Description>
<AssemblyName>AWS.Lambda.Powertools.Common</AssemblyName>
<RootNamespace>AWS.Lambda.Powertools.Common</RootNamespace>
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
<PackageId>AWS.Lambda.Powertools.Common</PackageId>
<Description>Powertools for AWS Lambda (.NET) - Core package.</Description>
<AssemblyName>AWS.Lambda.Powertools.Common</AssemblyName>
<RootNamespace>AWS.Lambda.Powertools.Common</RootNamespace>
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
</PropertyGroup>

<ItemGroup>
<!-- Package versions are Centrally managed in Directory.Packages.props file -->
<!-- More info https://learn.microsoft.com/en-us/nuget/consume-packages/central-package-management -->
<!-- Package versions are Centrally managed in Directory.Packages.props file -->
<!-- More info https://learn.microsoft.com/en-us/nuget/consume-packages/central-package-management -->
<PackageReference Include="Amazon.Lambda.Core"/>
<PackageReference Include="AspectInjector"/>
</ItemGroup>

Expand Down
9 changes: 9 additions & 0 deletions libraries/src/AWS.Lambda.Powertools.Common/Core/Constants.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
* permissions and limitations under the License.
*/

// ReSharper disable InconsistentNaming
namespace AWS.Lambda.Powertools.Common;

/// <summary>
Expand Down Expand Up @@ -143,4 +144,12 @@ internal static class Constants
/// Constant for POWERTOOLS_METRICS_DISABLED environment variable
/// </summary>
internal const string PowertoolsMetricsDisabledEnv = "POWERTOOLS_METRICS_DISABLED";

/// <summary>
/// A unique and opaque application ID that is appended to the
/// User-Agent header as app/sdk_ua_app_id. It should have a
/// maximum length of 50. This variable is sourced from environment
/// variable AWS_SDK_UA_APP_ID
/// </summary>
internal const string AWSSdkUAAppId = "AWS_SDK_UA_APP_ID";
}
Original file line number Diff line number Diff line change
Expand Up @@ -127,12 +127,6 @@ public interface IPowertoolsConfigurations
/// <returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
bool GetEnvironmentVariableOrDefault(string variable, bool defaultValue);

/// <summary>
/// Sets the execution Environment Variable (AWS_EXECUTION_ENV)
/// </summary>
/// <param name="type"></param>
void SetExecutionEnvironment<T>(T type);

/// <summary>
/// Gets a value indicating whether [Idempotency is disabled].
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,11 @@ public interface IPowertoolsEnvironment
/// <typeparam name="T"></typeparam>
/// <returns>Assembly Version in the Major.Minor.Build format</returns>
string GetAssemblyVersion<T>(T type);

/// <summary>
/// Sets the execution Environment Variable (AWS_EXECUTION_ENV)
/// Sets the execution Environment Variable (AWS_SDK_UA_APP_ID)
/// </summary>
/// <param name="type"></param>
void SetExecutionEnvironment<T>(T type);
/// <param name="utilityName"></param>
void SetExecutionEnvironment<T>(T type, string utilityName = null);
}
Original file line number Diff line number Diff line change
Expand Up @@ -182,12 +182,6 @@ public bool GetEnvironmentVariableOrDefault(string variable, bool defaultValue)
public bool TracingDisabled =>
GetEnvironmentVariableOrDefault(Constants.TracingDisabledEnv, false);

/// <inheritdoc />
public void SetExecutionEnvironment<T>(T type)
{
_powertoolsEnvironment.SetExecutionEnvironment(type);
}

/// <inheritdoc />
public bool IdempotencyDisabled =>
GetEnvironmentVariableOrDefault(Constants.IdempotencyDisabledEnv, false);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,43 +69,34 @@ public string GetAssemblyVersion<T>(T type)
}

/// <inheritdoc />
public void SetExecutionEnvironment<T>(T type)
public void SetExecutionEnvironment<T>(T type, string utilityName = null)
{
const string envName = Constants.AwsExecutionEnvironmentVariableName;
const string envName = Constants.AWSSdkUAAppId;
var currentEnvValue = GetEnvironmentVariable(envName);
var assemblyName = ParseAssemblyName(GetAssemblyName(type));
var assemblyName = utilityName != null ? $"{Constants.FeatureContextIdentifier}/{utilityName}" : ParseAssemblyName(GetAssemblyName(type));
var assemblyVersion = GetAssemblyVersion(type);
var newEntry = $"{assemblyName}/{assemblyVersion}";

// Check for duplication early
if (!string.IsNullOrEmpty(currentEnvValue) && currentEnvValue.Contains(assemblyName))
{
return;
}

var assemblyVersion = GetAssemblyVersion(type);
var newEntry = $"{assemblyName}/{assemblyVersion}";

string finalValue;

var ptenvIndex = currentEnvValue?.IndexOf("PTENV/") ?? -1;

if (string.IsNullOrEmpty(currentEnvValue))
{
// First entry: "PT/Assembly/1.0.0 PTENV/AWS_LAMBDA_DOTNET8"
finalValue = $"{newEntry} {CachedRuntimeEnvironment}";
}
else if (ptenvIndex >= 0)
{
// Insert newEntry before PTENV
finalValue = $"{currentEnvValue.Substring(0, ptenvIndex).TrimEnd()} {newEntry} {currentEnvValue.Substring(ptenvIndex)}".Trim();
}
else
{
// Check if PTENV already exists in one pass
var containsPtenv = currentEnvValue.Contains("PTENV/");

if (containsPtenv)
{
// Just append the new entry: "existing PT/Assembly/1.0.0"
finalValue = $"{currentEnvValue} {newEntry}";
}
else
{
// Append new entry + PTENV: "existing PT/Assembly/1.0.0 PTENV/AWS_LAMBDA_DOTNET8"
finalValue = $"{currentEnvValue} {newEntry} {CachedRuntimeEnvironment}";
}
finalValue = $"{currentEnvValue} {newEntry} {CachedRuntimeEnvironment}";
}

SetEnvironmentVariable(envName, finalValue);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<ItemGroup>
<PackageReference Include="Microsoft.AspNetCore.Http" />
<PackageReference Include="Microsoft.AspNetCore.Http.Abstractions" />
<PackageReference Include="Microsoft.CodeAnalysis.Common" />
</ItemGroup>
<ItemGroup>
<FrameworkReference Include="Microsoft.AspNetCore.App" />
Expand Down
Loading
Loading