Add AWS AppSyncEvent by PankajRawat333 · Pull Request #1939 · aws/aws-lambda-dotnet

PankajRawat333 · 2025-01-24T14:21:20Z

Issue #, if available:
#1938

Description of changes:

Added AWS AppSyncEvent to consume and process event directly on Lambda function.
Added unit tests

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

ashishdhingra · 2025-01-24T18:03:53Z

@PankajRawat333 Thanks for the PR. Please refer type information from https://www.npmjs.com/package/@types/aws-lambda?activeTab=code. Source: https://github.com/aws-samples/cdk-typescript-appsync-lambda/blob/main/src/Resolver/src/resolver.ts#L24.

PankajRawat333 · 2025-01-30T13:25:28Z

@ashishdhingra I have updated type according to above link.

ashishdhingra · 2025-01-30T18:11:56Z

@ashishdhingra I have updated type according to above link.

@PankajRawat333 Thanks for addressing comments for the PR. Discussed this PR with the team. @normj would have a high level look. Meanwhile, could you also please follow up with the Lambda team to get the schema details and data types for each field (since these are not documented in detail)? We would need to make sure to use the correct types for each field to avoid making any breaking changes in future for missed scenario.

PankajRawat333 · 2025-02-06T13:20:23Z

@ashishdhingra Received the AppSync schema from the internal group in the aws-powertool repository. All type information was accurate, but I renamed a few classes based on the schema.

ashishdhingra · 2025-02-14T17:55:54Z

@ashishdhingra Received the AppSync schema from the internal group in the aws-powertool repository. All type information was accurate, but I renamed a few classes based on the schema.

@PankajRawat333 Provided some review comments. Also update test cases (and JSON file names) accordingly while addressing the review comments.

ashishdhingra · 2025-01-24T17:54:36Z

+            /// <summary>
+            /// Gets or sets the variables passed to the GraphQL operation.
+            /// </summary>
+            public Dictionary<string, object> Variables { get; set; }


Should the data type for key value be object or string? Refer https://docs.powertools.aws.dev/lambda/python/1.15.0/api/utilities/data_classes/appsync_resolver_event.html#aws_lambda_powertools.utilities.data_classes.appsync_resolver_event.AppSyncResolverEventInfo.variables.

Per https://www.npmjs.com/package/@types/aws-lambda?activeTab=code, the data type for value is any. So we are good for it to be object.

ashishdhingra · 2025-02-14T17:47:16Z

+    /// <summary>
+    /// Represents the event payload received from AWS AppSync.
+    /// </summary>
+    public class AppSyncEvent<TArguments>


This appears to be a Resolver event. Should we change the name to AppSyncResolverEvent<TArguments>? Refer:

https://www.npmjs.com/package/@types/aws-lambda?activeTab=code

https://github.com/aws-powertools/powertools-lambda-typescript/blob/09f0aaaf92233d326acd9e5fbd21a5c241cdbfe7/packages/parser/src/schemas/appsync.ts#L108

We would also need to change documentation comment for this class, update Readme and it's example.

Is AppSyncAuthorizerEvent outside the scope for this PR for now?

@PankajRawat333 Please advise if AppSyncAuthorizerEvent outside the scope for this PR for now.

Updated. Added all type of appsync authorization

I was asking to validate if AppSyncAuthorizerEvent (and AppSyncAuthorizerResult) it out of scope for now, refer such event in https://www.npmjs.com/package/@types/aws-lambda?activeTab=code.

@ashishdhingra Initially, I was considering not including this, but after reviewing the documentation, I don't see any problem. Added AppSyncAuthorizerEvent & AppSyncAuthorizerResult now.

ashishdhingra · 2025-02-14T17:49:13Z

+    /// <summary>
+    /// Represents Amazon Cognito User Pools authorization identity for AppSync
+    /// </summary>
+    public class AppSyncCognitoIdentity


Why we didn't implement AppSyncOidcIdentity and AppSyncLambdaIdentity? Please refer below links:

https://github.com/aws-powertools/powertools-lambda-typescript/blob/09f0aaaf92233d326acd9e5fbd21a5c241cdbfe7/packages/parser/src/schemas/appsync.ts#L34

https://www.npmjs.com/package/@types/aws-lambda?activeTab=code

@PankajRawat333 Please advise on this.

Added AppSyncOidcIdentity and AppSyncLambdaIdentity

ashishdhingra · 2025-02-21T02:21:04Z

+
+# Sample Function
+
+The following is a sample class and Lambda function that receives AppSync event record data as an `appSyncResolverEvent` and logs some of the incoming event data. (Note that by default anything written to Console will be logged as CloudWatch Logs events.)


Please change AppSync to AppSync resolver

ashishdhingra · 2025-02-21T02:34:18Z

@PankajRawat333 PR builds line locally and AppSync tests are successful. Please advise on the following comments:

Also,

Target your PR to dev, resolving merge conflicts, if any. All changes in this repository are staged to dev first before getting released.
Add changefile for versioning, refer https://github.com/aws/aws-lambda-dotnet/blob/master/CONTRIBUTING.md#adding-a-change-file-to-your-contribution-branch

ashishdhingra · 2025-03-07T22:26:39Z

+  "Projects": [
+    {
+      "Name": "Amazon.Lambda.AppSyncEvents",
+      "Type": "Patch",


The increment type should have been Major instead of Patch since this is a new package. You should have used --increment-type Major parameter while using autover (It's not well documented though, 😞)

Also, I was asking to validate if validate if AppSyncAuthorizerEvent (and AppSyncAuthorizerResult) are out of scope for now, refer such event and result type at https://www.npmjs.com/package/@types/aws-lambda?activeTab=code.

The increment type should have been Major instead of Patch since this is a new package. You should have used --increment-type Major parameter while using autover (It's not well documented though, 😞)

@philasmar Please review comment #1939 (comment). Should we be specifying version in .csproj file for 1st version? Also should the --increment-type be Major for this use case.

ashishdhingra · 2025-03-07T22:30:56Z

+    <Description>Amazon Lambda .NET Core support - AWS AppSync package.</Description>
+	<TargetFrameworks>netstandard2.0;netcoreapp3.1;net8.0</TargetFrameworks>
+    <AssemblyTitle>Amazon.Lambda.AppSyncEvents</AssemblyTitle>
+    <Version>1.0.0</Version>


I'm unsure if we should specify version when using 1st autover change file. CCing @philasmar for inputs.

You should specify a version below 1.0.0, like 0.0.1 and then use the increment type Major which would bump it to 1.0.0.

@philasmar Help me to understand your comment. My current .csproj file version is 0.0.1. Running autover with Major increment type won't automatically change the version in the .csproj file and just add new changefile.

@PankajRawat333 Which autover command are you using?
The actual versioning of the project will happen when we start a release. You do not need to worry about incrementing it to 1.0.0 yourself. The 2 things that need to be done from your end prior to us merging this PR is set your .csproj Version to 0.0.1, which it is, and have a change file included in the PR with an increment type set to Major, which you don't. You just need to update that from Patch to Major. If you wanted to recreate the file, you could run:

autover change --increment-type Major --project-name Amazon.Lambda.AppSyncEvents -m "Your changelog message"

Make sure to delete the old change file if you decide to create a new one.

From our end, once the PR is merged in, we will create a release which will automatically run:

autover version
autover changelog

This will look at the available change files and perform the needed version increment for the projects.

Also please add the new project in this section https://github.com/aws/aws-lambda-dotnet/blob/master/CONTRIBUTING.md#adding-a-change-file-to-your-contribution-branch

Thanks @philasmar, Now created new changefile with increment-type Major and updated readme.

PankajRawat333 · 2025-03-12T10:26:11Z

+    public class AppSyncAuthorizerResult
+    {
+        // Indicates if the request is authorized
+#if NETSTANDARD_2_0


@ashishdhingra Added JsonProperty attribute, since AWS AppSync is case sensitive. I hope this is correct way to support both type of serializer.

Almost there.

Please follow approach at

aws-lambda-dotnet/Libraries/src/Amazon.Lambda.KinesisEvents/KinesisTimeWindowResponse.cs

Line 33 in 6eca899

#if NETCOREAPP3_1_OR_GREATER

. Amazon.Lambda.KinesisEvents also targets netstandard2.0;netcoreapp3.1;net8.0.

Also, readme doesn't demonstrate AppSyncAuthorizerEvent and AppSyncAuthorizerResult. Perhaps, we should add it as well (refer https://docs.aws.amazon.com/appsync/latest/devguide/security-authz.html). And also update test cases.

Once this is done, I will pull PR branch locally and validate.

@ashishdhingra - Pushed the following changes:

Updated README file to show how to use custom lambda authorizer

Used #if NETCOREAPP3_1_OR_GREATER directive in AppSyncAuthorizerResult class

Added unit tests for AppSyncAuthorizerEvent & AppSyncAuthorizerResult classes

Updated XML documentation comments

Simplified csproj file as per other event projects

Added new tests, updated readme and incorporated review comments](9b8f7ae)

ashishdhingra · 2025-03-19T18:37:40Z

+    public class AppSyncAuthorizerResult
+    {
+        // Indicates if the request is authorized
+#if NETSTANDARD_2_0


Almost there.

Please follow approach at

aws-lambda-dotnet/Libraries/src/Amazon.Lambda.KinesisEvents/KinesisTimeWindowResponse.cs

Line 33 in 6eca899

#if NETCOREAPP3_1_OR_GREATER

. Amazon.Lambda.KinesisEvents also targets netstandard2.0;netcoreapp3.1;net8.0.

Also, readme doesn't demonstrate AppSyncAuthorizerEvent and AppSyncAuthorizerResult. Perhaps, we should add it as well (refer https://docs.aws.amazon.com/appsync/latest/devguide/security-authz.html). And also update test cases.

Once this is done, I will pull PR branch locally and validate.

ashishdhingra · 2025-03-24T18:05:15Z

+## Example of Custom Lambda Authorizer
+This example demonstrates how to implement a custom Lambda authorizer for AppSync using the AppSync Events package. The authorizer function receives an `AppSyncAuthorizerEvent` containing the authorization token and request context. It returns an `AppSyncAuthorizerResult` that determines whether the request is authorized and includes additional context.
+
+The function also provides some data in the `resolverContext` object. This information is available in the AppSync resolver’s context `identity` object.


This information is available in the AppSync resolver’s context identity object.

What is the identity object we are talking about? ResolverContext in the AppSyncAuthorizerResult is a Dictionary. Or is it some other source which might be missing here?

@ashishdhingra - Update the above explanation.

ashishdhingra · 2025-03-24T18:20:26Z

Tests pass locally with latest changes from PR.

ashishdhingra · 2025-03-24T18:22:06Z

@PankajRawat333 / @ankushjain358 Please review comment #1939 (comment).

Else PR looks good. Test pass locally. CC @philasmar / @normj for 2nd review.

ashishdhingra

Looks complete to me. Need to have 2nd review as well.

philasmar · 2025-03-25T13:01:10Z

      "Name": "Amazon.Lambda.TestTool",
      "Path": "Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Amazon.Lambda.TestTool.csproj"
+    },
+	  {


nit: fix indentation

philasmar · 2025-03-25T13:11:37Z

+  <Import Project="..\..\..\buildtools\common.props" />
+
+  <PropertyGroup>
+    <Description>Amazon Lambda .NET Core support - AWS AppSync package.</Description>


nit: we don't need to mention "Core"

philasmar · 2025-03-25T13:11:59Z

+
+  <PropertyGroup>
+    <Description>Amazon Lambda .NET Core support - AWS AppSync package.</Description>
+    <TargetFrameworks>netstandard2.0;netcoreapp3.1;net8.0</TargetFrameworks>


Since this is a new package, we should only target net8.0

NET 8 test was written in the 'EventsTests.NET6' project, so I included both net6.0 and net8.0

We shouldn't add a "net6.0" target. For the tests, you could create a 'EventsTests.NET8' project and add the tests there.

Added new project - EventsTests.NET8

philasmar · 2025-03-25T13:12:23Z

+    <PackageTags>AWS;Amazon;Lambda</PackageTags>
+  </PropertyGroup>
+
+	<PropertyGroup Condition="'$(TargetFramework)' == 'net8.0'">


No need for the condition if we only target net8.0

This condition should only be removed if the targets are net8 and higher. Right now, you are targeting both net6 and net8. You should drop net6.

Now target framework is only net8.0

philasmar · 2025-03-25T13:14:56Z

+                /// Indicates if the request is authorized
+                /// </summary>
+                [DataMember(Name = "isAuthorized")]
+#if NETCOREAPP3_1_OR_GREATER


not needed once we target net8

philasmar · 2025-03-25T13:17:04Z

@@ -0,0 +1,16 @@
+using System.Collections.Generic;
+
+namespace Amazon.Lambda.AppSyncEvents


nit: use top level statement

philasmar · 2025-03-25T13:17:19Z

+namespace Amazon.Lambda.AppSyncEvents
+{
+    /// <summary>
+    /// Represents AWS LAMBDA authorization identity for AppSync


nit: why is "LAMBDA" all caps?

philasmar · 2025-03-25T13:17:32Z

@@ -0,0 +1,25 @@
+using System.Collections.Generic;
+
+namespace Amazon.Lambda.AppSyncEvents


nit: use top level statement

philasmar · 2025-03-25T13:17:59Z

+namespace Amazon.Lambda.AppSyncEvents
+{
+    /// <summary>
+    /// Represents OPENID CONNECT authorization identity for AppSync


nit: why is "OPENID CONNECT" all caps?

philasmar · 2025-03-25T13:18:09Z

@@ -0,0 +1,104 @@
+using System.Collections.Generic;
+
+namespace Amazon.Lambda.AppSyncEvents


nit: use top level statement

philasmar · 2025-04-01T13:34:58Z

-		<WarningsAsErrors>IL2026,IL2067,IL2075</WarningsAsErrors>
-		<IsTrimmable>true</IsTrimmable>
+  <PropertyGroup>
+    <WarningsAsErrors>IL2026,IL2067,IL2075,IL3050</WarningsAsErrors>


why did you add IL3050?

Removed, added by mistake

philasmar · 2025-04-21T14:20:43Z

+
+  <PropertyGroup>
+    <TargetFrameworks>net8.0</TargetFrameworks>
+    <PackageId>EventsTests31</PackageId>


Update this to EventsTests8

philasmar · 2025-04-25T19:37:58Z

The package https://www.nuget.org/packages/Amazon.Lambda.AppSyncEvents has been released. Thank you for your contribution!

Pankaj Rawat and others added 4 commits January 14, 2025 14:12

Initial changes for AppSyncEvent

64d401c

Added AppSyncEvent class, and respective test cases

4335914

Updated README

f287562

Update readme

1bb2045

afroz429 requested review from ashishdhingra, normj and philasmar January 24, 2025 18:34

Update Arguments type in event

033f1e8

Update schema

204e17a

ashishdhingra reviewed Feb 17, 2025

View reviewed changes

fix review comment

87f899a

ashishdhingra reviewed Feb 21, 2025

View reviewed changes

Added Lambda and oidc auth type

8ebea50

PankajRawat333 changed the base branch from master to dev March 7, 2025 12:39

Pankaj Rawat added 2 commits March 7, 2025 18:13

Update readme

24aafb0

Added changefile

634f4a4

PankajRawat333 changed the base branch from dev to master March 7, 2025 13:56

PankajRawat333 changed the base branch from master to dev March 7, 2025 13:56

merge from master

2fdb768

ashishdhingra requested changes Mar 7, 2025

View reviewed changes

ashishdhingra reviewed Mar 7, 2025

View reviewed changes

Pankaj Rawat added 3 commits March 11, 2025 12:56

Added AuthorizerEvent and Result

0ad9cd6

update changefile and readme

f2af59d

Update JsonProperty attribute

247a2be

Test case updated

4356b85

PankajRawat333 commented Mar 12, 2025

View reviewed changes

ashishdhingra requested changes Mar 19, 2025

View reviewed changes

ankushjain358 added 2 commits March 23, 2025 13:55

Added new tests, updated readme and incorporated review comments

9b8f7ae

Updated README

f94d588

PankajRawat333 requested a review from ashishdhingra March 24, 2025 13:49

ashishdhingra reviewed Mar 24, 2025

View reviewed changes

Updated README

5180735

ashishdhingra approved these changes Mar 24, 2025

View reviewed changes

philasmar requested changes Mar 25, 2025

View reviewed changes

Pankaj Rawat and others added 5 commits March 28, 2025 13:36

fixed code review comments

0708f45

fixed formatting

d7cd825

Revert warning and remove condition

1c34513

Merge branch 'aws:master' into add-aws-appsync-event

1530839

Added .net8 directive

06fe270

ashishdhingra requested a review from philasmar March 28, 2025 21:30

philasmar requested changes Apr 1, 2025

View reviewed changes

Pankaj Rawat and others added 8 commits April 3, 2025 15:01

Remove warning

308156c

fixed review comments

e37ad36

fix formatting

3990078

Refactor .NET8 and 6 test

25190da

Moved AppSync tests to a new prpject

d2469ca

Merge remote-tracking branch 'upstream/dev' into add-aws-appsync-event

11723b0

Reverted EventTests file

089f411

Merge remote-tracking branch 'upstream/dev' into add-aws-appsync-event

e74bda3

philasmar approved these changes Apr 25, 2025

View reviewed changes

philasmar merged commit a146de9 into aws:dev Apr 25, 2025
5 of 6 checks passed


		# Sample Function

		The following is a sample class and Lambda function that receives AppSync event record data as an `appSyncResolverEvent` and logs some of the incoming event data. (Note that by default anything written to Console will be logged as CloudWatch Logs events.)

		@@ -0,0 +1,16 @@
		using System.Collections.Generic;

		namespace Amazon.Lambda.AppSyncEvents

		@@ -0,0 +1,25 @@
		using System.Collections.Generic;

		namespace Amazon.Lambda.AppSyncEvents

		@@ -0,0 +1,104 @@
		using System.Collections.Generic;

		namespace Amazon.Lambda.AppSyncEvents

Conversation

PankajRawat333 commented Jan 24, 2025

Uh oh!

ashishdhingra commented Jan 24, 2025

Uh oh!

PankajRawat333 commented Jan 30, 2025

Uh oh!

ashishdhingra commented Jan 30, 2025

Uh oh!

PankajRawat333 commented Feb 6, 2025

Uh oh!

ashishdhingra commented Feb 14, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PankajRawat333 Mar 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ashishdhingra commented Feb 21, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PankajRawat333 Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ashishdhingra Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ankushjain358 Mar 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ashishdhingra Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

PankajRawat333 Mar 7, 2025 •

edited

Loading

PankajRawat333 Mar 12, 2025 •

edited

Loading

ashishdhingra Mar 19, 2025 •

edited

Loading

ankushjain358 Mar 23, 2025 •

edited

Loading

ashishdhingra Mar 19, 2025 •

edited

Loading