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.

Sign up for GitHub

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

Remove SDK dependency from DynamoDBEvent #1648

Merged
merged 2 commits into from
Jan 12, 2024
Merged

Remove SDK dependency from DynamoDBEvent #1648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3818b8d
refactor: Remove SDK dependency from DynamoDBEvent
dscpinheiro Jan 9, 2024
3bd10bc
refactor: Address PR feedback
dscpinheiro Jan 10, 2024
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
18 changes: 7 additions & 11 deletions Libraries/src/Amazon.Lambda.DynamoDBEvents/Amazon.Lambda.DynamoDBEvents.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,26 @@
<Import Project="..\..\..\buildtools\common.props" />

<PropertyGroup>
<TargetFrameworks>netstandard2.0;netcoreapp3.1;net8.0</TargetFrameworks>
dscpinheiro marked this conversation as resolved.
Show resolved Hide resolved
<TargetFrameworks>netcoreapp3.1;net8.0</TargetFrameworks>
<Description>Amazon Lambda .NET Core support - DynamoDBEvents package.</Description>
<AssemblyTitle>Amazon.Lambda.DynamoDBEvents</AssemblyTitle>
<VersionPrefix>2.3.0</VersionPrefix>
<VersionPrefix>3.0.0</VersionPrefix>
<AssemblyName>Amazon.Lambda.DynamoDBEvents</AssemblyName>
<PackageId>Amazon.Lambda.DynamoDBEvents</PackageId>
<PackageTags>AWS;Amazon;Lambda</PackageTags>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="AWSSDK.DynamoDBv2" Version="3.7.3.24" />
</ItemGroup>

<ItemGroup>
<Compile Remove="Converters\DictionaryLongToStringJsonConverter.cs" />
</ItemGroup>

<ItemGroup Condition=" '$(TargetFramework)' != 'netstandard2.0' ">
<Compile Include="Converters\DictionaryLongToStringJsonConverter.cs" />
</ItemGroup>
<PropertyGroup Condition="'$(TargetFramework)' == 'net8.0'">
<WarningsAsErrors>IL2026,IL2067,IL2075</WarningsAsErrors>
<IsTrimmable>true</IsTrimmable>

<PropertyGroup Condition="'$(TargetFramework)' == 'net8.0'">
<WarningsAsErrors>IL2026,IL2067,IL2075</WarningsAsErrors>
<IsTrimmable>true</IsTrimmable>
<EnableTrimAnalyzer>true</EnableTrimAnalyzer>
</PropertyGroup>
</PropertyGroup>
</Project>
309 changes: 303 additions & 6 deletions Libraries/src/Amazon.Lambda.DynamoDBEvents/DynamoDBEvent.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
namespace Amazon.Lambda.DynamoDBEvents
{
using Amazon.DynamoDBv2.Model;
using System;
using System.Collections.Generic;
using System.IO;

/// <summary>
/// AWS DynamoDB event
/// http://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html
/// http://docs.aws.amazon.com/lambda/latest/dg/eventsources.html#eventsources-ddb-update
/// </summary>
#if NET8_0_OR_GREATER
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("DynamoDBEvent has a reference to the AWS SDK for .NET. The ConstantClass used to represent enums in the SDK is not supported in the Lambda serializer SourceGeneratorLambdaJsonSerializer for trimming scenarios.")]
#endif
public class DynamoDBEvent
{
/// <summary>
Expand All @@ -21,15 +18,315 @@ public class DynamoDBEvent

/// <summary>
/// DynamoDB stream record
/// http://docs.aws.amazon.com/dynamodbstreams/latest/APIReference/API_StreamRecord.html
/// https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_Record.html
/// </summary>
public class DynamodbStreamRecord : Record
public class DynamodbStreamRecord
{
/// <summary>
/// The event source arn of DynamoDB.
/// </summary>
public string EventSourceArn { get; set; }

/// <summary>
/// The region in which the <c>GetRecords</c> request was received.
/// </summary>
public string AwsRegion { get; set; }

/// <summary>
/// The main body of the stream record, containing all of the DynamoDB-specific fields.
/// </summary>
public StreamRecord Dynamodb { get; set; }

/// <summary>
/// A globally unique identifier for the event that was recorded in this stream record.
/// </summary>
public string EventID { get; set; }

/// <summary>
/// <para>
/// The type of data modification that was performed on the DynamoDB table:
/// </para>
/// <ul>
/// <li>
/// <para>
/// <c>INSERT</c> - a new item was added to the table.
/// </para>
/// </li>
///
/// <li>
/// <para>
/// <c>MODIFY</c> - one or more of an existing item's attributes were modified.
/// </para>
/// </li>
///
/// <li>
/// <para>
/// <c>REMOVE</c> - the item was deleted from the table
/// </para>
/// </li>
/// </ul>
/// </summary>
public string EventName { get; set; }

/// <summary>
/// The Amazon Web Services service from which the stream record originated. For DynamoDB
/// Streams, this is <c>aws:dynamodb</c>.
/// </summary>
public string EventSource { get; set; }

/// <summary>
/// <para>
/// The version number of the stream record format. This number is updated whenever the
/// structure of <c>Record</c> is modified.
/// </para>
///
/// <para>
/// Client applications must not assume that <c>eventVersion</c> will remain at
/// a particular value, as this number is subject to change at any time. In general, <c>eventVersion</c>
/// will only increase as the low-level DynamoDB Streams API evolves.
/// </para>
/// </summary>
public string EventVersion { get; set; }

/// <summary>
/// <para>Items that are deleted by the Time to Live process after expiration have the following fields:</para>
/// <ul>
/// <li>
/// <para>Records[].userIdentity.type</para>
/// <para>"Service"</para>
/// </li>
/// <li>
/// <para>Records[].userIdentity.principalId</para>
/// <para>"dynamodb.amazonaws.com"</para>
/// </li>
/// </ul>
/// </summary>
public Identity UserIdentity { get; set; }
}

/// <summary>
/// A description of a single data modification that was performed on an item in a DynamoDB table.
/// </summary>
public class StreamRecord
{
/// <summary>
/// The approximate date and time when the stream record was created, in <a href="http://www.epochconverter.com/">UNIX
/// epoch time</a> format and rounded down to the closest second.
/// </summary>
public DateTime ApproximateCreationDateTime { get; set; }

/// <summary>
/// The primary key attribute(s) for the DynamoDB item that was modified.
/// </summary>
public Dictionary<string, AttributeValue> Keys { get; set; }

/// <summary>
/// The item in the DynamoDB table as it appeared after it was modified.
/// </summary>
public Dictionary<string, AttributeValue> NewImage { get; set; }

/// <summary>
/// The item in the DynamoDB table as it appeared before it was modified.
/// </summary>
public Dictionary<string, AttributeValue> OldImage { get; set; }

/// <summary>
/// The sequence number of the stream record.
/// </summary>
public string SequenceNumber { get; set; }

/// <summary>
/// The size of the stream record, in bytes.
/// </summary>
public long SizeBytes { get; set; }

/// <summary>
/// <para>
/// The type of data from the modified DynamoDB item that was captured in this stream record:
/// </para>
///
/// <ul>
/// <li>
/// <para>
/// <c>KEYS_ONLY</c> - only the key attributes of the modified item.
/// </para>
/// </li>
///
/// <li>
/// <para>
/// <c>NEW_IMAGE</c> - the entire item, as it appeared after it was modified.
/// </para>
/// </li>
///
/// <li>
/// <para>
/// <c>OLD_IMAGE</c> - the entire item, as it appeared before it was modified.
/// </para>
/// </li>
///
/// <li>
/// <para>
/// <c>NEW_AND_OLD_IMAGES</c> - both the new and the old item images of the item.
/// </para>
/// </li>
/// </ul>
/// </summary>
public string StreamViewType { get; set; }
Copy link
Member

Choose a reason for hiding this comment

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

This is an enum in the SDK, should we try to reproduce here? Though I suppose a plain .NET enum isn't as flexible as the generated constant class we use.

https://github.com/aws/aws-sdk-net/blob/459d2e5410af5a5b0e26ba6951e75bf0c420351a/sdk/src/Services/DynamoDBv2/Generated/Model/StreamRecord.cs#L180

Copy link
Member

Choose a reason for hiding this comment

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

We have to use string to be forward compatible with new enum values and we don't have the ConstantClass to use here. Which the ConstantClass cause other fun JSON serialization issues.

}

/// <summary>
/// Contains details about the type of identity that made the request.
/// </summary>
public class Identity
{
/// <summary>
/// A unique identifier for the entity that made the call. For Time To Live, the principalId
/// is "dynamodb.amazonaws.com".
/// </summary>
public string PrincipalId { get; set; }

/// <summary>
/// The type of the identity. For Time To Live, the type is "Service".
/// </summary>
public string Type { get; set; }
}

/// <summary>
/// Represents the data for an attribute.
///
/// <para>
/// Each attribute value is described as a name-value pair. The name is the data type,
/// and the value is the data itself.
/// </para>
///
/// <para>
/// For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes">Data
/// Types</a> in the <i>Amazon DynamoDB Developer Guide</i>.
/// </para>
/// </summary>
public class AttributeValue
{
/// <summary>
/// <para>
/// An attribute of type Binary. For example:
/// </para>
///
/// <para>
/// <c>"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"</c>
/// </para>
/// </summary>
public MemoryStream B { get; set; }

/// <summary>
/// <para>
/// An attribute of type Boolean. For example:
/// </para>
///
/// <para>
/// <c>"BOOL": true</c>
/// </para>
/// </summary>
public bool? BOOL { get; set; }

/// <summary>
/// <para>
/// An attribute of type Binary Set. For example:
/// </para>
///
/// <para>
/// <c>"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]</c>
/// </para>
/// </summary>
public List<MemoryStream> BS { get; set; }

/// <summary>
/// <para>
/// An attribute of type List. For example:
/// </para>
///
/// <para>
/// <c>"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]</c>
/// </para>
/// </summary>
public List<AttributeValue> L { get; set; }

/// <summary>
/// <para>
/// An attribute of type Map. For example:
/// </para>
///
/// <para>
/// <c>"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}</c>
/// </para>
/// </summary>
public Dictionary<string, AttributeValue> M { get; set; }

/// <summary>
/// <para>
/// An attribute of type Number. For example:
/// </para>
///
/// <para>
/// <c>"N": "123.45"</c>
/// </para>
///
/// <para>
/// Numbers are sent across the network to DynamoDB as strings, to maximize compatibility
/// across languages and libraries. However, DynamoDB treats them as number type attributes
/// for mathematical operations.
/// </para>
/// </summary>
public string N { get; set; }

/// <summary>
/// <para>
/// An attribute of type Number Set. For example:
/// </para>
///
/// <para>
/// <c>"NS": ["42.2", "-19", "7.5", "3.14"]</c>
/// </para>
///
/// <para>
/// Numbers are sent across the network to DynamoDB as strings, to maximize compatibility
/// across languages and libraries. However, DynamoDB treats them as number type attributes
/// for mathematical operations.
/// </para>
/// </summary>
public List<string> NS { get; set; }

/// <summary>
/// <para>
/// An attribute of type Null. For example:
/// </para>
///
/// <para>
/// <c>"NULL": true</c>
/// </para>
/// </summary>
public bool? NULL { get; set; }

/// <summary>
/// <para>
/// An attribute of type String. For example:
/// </para>
///
/// <para>
/// <c>"S": "Hello"</c>
/// </para>
/// </summary>
public string S { get; set; }

/// <summary>
/// <para>
/// An attribute of type String Set. For example:
/// </para>
///
/// <para>
/// <c>"SS": ["Giraffe", "Hippo" ,"Zebra"]</c>
/// </para>
/// </summary>
public List<string> SS { get; set; }
}
}
}
2 changes: 0 additions & 2 deletions Libraries/src/Amazon.Lambda.DynamoDBEvents/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

This package contains classes that can be used as input types for Lambda functions that process Amazon DynamoDB events.

This package has a dependency on the [AWS SDK for .NET package DynamoDBv2](https://www.nuget.org/packages/AWSSDK.DynamoDBv2/) in order to use the `Amazon.DynamoDBv2.Model.Record` type.

# Sample Function

The following is a sample class and Lambda function that receives Amazon DynamoDB event record data as an input and writes some of the incoming event data to CloudWatch Logs. (Note that by default anything written to Console will be logged as CloudWatch Logs events.)
Expand Down
2 changes: 1 addition & 1 deletion Libraries/src/Amazon.Lambda.Serialization.Json/Amazon.Lambda.Serialization.Json.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<AssemblyName>Amazon.Lambda.Serialization.Json</AssemblyName>
<PackageId>Amazon.Lambda.Serialization.Json</PackageId>
<PackageTags>AWS;Amazon;Lambda</PackageTags>
<VersionPrefix>2.1.1</VersionPrefix>
<VersionPrefix>2.2.0</VersionPrefix>
</PropertyGroup>

<ItemGroup>
Expand Down
Loading
Loading