feat(data-classes): AppSync Resolver Event #323

michaelbrewer · 2021-03-10T09:40:33Z

Description of changes:

Add support for AppSync Resolver Events either Direct or Amplify

from aws_lambda_powertools.utilities.data_classes import AppSyncResolverEvent
from aws_lambda_powertools.utilities.typing import LambdaContext


def handler(event: dict, context: LambdaContext):
    event = AppSyncResolverEvent(event)
    assert event.type_name == "Merchant"
    assert event.field_name == "locations"
    assert event.info.parent_type_name == event.type_name
    assert event.info.field_name == event.field_name

Can also be used as a decorator

from aws_lambda_powertools import Logger
from aws_lambda_powertools.utilities.data_classes import AppSyncResolverEvent
from aws_lambda_powertools.utilities.data_classes.appsync.resolver_utils import (
    AppSyncResolver
)
from aws_lambda_powertools.utilities.data_classes.appsync.scalar_types_utils import (
    make_id,
    aws_date,
    aws_datetime,
    aws_time,
    aws_timestamp,
)

logger = Logger()
app = AppSyncResolver()


@app.resolver(field_name="listLocations", include_event=True)
@app.resolver(type_name="Merchant", field_name="locations", include_event=True)
def get_locations(event: AppSyncResolverEvent, name: str = None):
    logger.info(event)
    return f"returning locations for {name}"


@app.resolver(type_name="Merchant", field_name="anotherField")
def another_field_resolver(count: int):
    return {
        "id": make_id(),
        "date": aws_date(),
        "date_time": aws_datetime(),
        "time": aws_time(),
        "ts": aws_timestamp(),
        "message": f"another_field_resolver with parameter count={count}",
    }


@app.resolver(type_name="Query", field_name="noParams")
def no_params():
    return "no_params has no params"


def handler(event: dict, context):
    return app.resolve(event, context)

This is based on what Amplify produces by default:

Key	Description
typeName	The name of the parent object type of the field being resolver.
fieldName	The name of the field being resolved.
arguments	A map containing the arguments passed to the field being resolved.
identity	A map containing identity information for the request. Contains a nested key ‘claims’ that will contains the JWT claims if they exist.
source	When resolving a nested field in a query, the source contains parent value at runtime. For example when resolving Post.comments, the source will be the Post object.
request	The AppSync request object. Contains header information.
prev	When using pipeline resolvers, this contains the object returned by the previous function. You can return the previous value for auditing use cases.

Which is a simplification of is possible in the app sync $context :

https://docs.aws.amazon.com/appsync/latest/devguide/resolver-context-reference.html

Key	Description
arguments	A map containing the arguments passed to the field being resolved.
identity	A map containing identity information for the request.
source	When resolving a nested field in a query, the source contains parent value at runtime. For example when resolving Post.comments, the source will be the Post object.
request	The AppSync request object. Contains header information.
prev	A container for the results of this resolver. This field is only available to response mapping templates. (like source)
info	An object that contains information about the GraphQL request.
stash	The stash is a map that is made available inside each resolver and function mapping template.

Checklist

Implement the identity class (API_KEY, AWS_IAM vs AMAZON_COGNITO_USER_POOLS)
Decide whether to create a data class specifically for Amplify ?
Add support for correlation id
Meet tenets criteria
Update tests
Update docs
PR title follows conventional commit semantics

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

codecov-io · 2021-03-10T16:10:42Z

Codecov Report

Merging #323 (8ba4495) into develop (6a9a554) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##           develop     #323    +/-   ##
=========================================
  Coverage    99.88%   99.88%            
=========================================
  Files           92       94     +2     
  Lines         3356     3519   +163     
  Branches       165      172     +7     
=========================================
+ Hits          3352     3515   +163     
  Misses           2        2            
  Partials         2        2

Impacted Files	Coverage Δ
aws_lambda_powertools/logging/correlation_paths.py	`100.00% <100.00%> (ø)`
...mbda_powertools/utilities/data_classes/__init__.py	`100.00% <100.00%> (ø)`
...ies/data_classes/appsync/appsync_resolver_event.py	`100.00% <100.00%> (ø)`
...s/utilities/data_classes/appsync/resolver_utils.py	`100.00% <100.00%> (ø)`
...lambda_powertools/utilities/data_classes/common.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6a9a554...8ba4495. Read the comment docs.

heitorlessa · 2021-03-10T16:54:03Z

hey @awsed - could you take a quick peek at this PR in case we're missing anything obvious from the Lambda Resolver event object?

aws_lambda_powertools/utilities/data_classes/appsync_resolver_event.py

aws_lambda_powertools/logging/correlation_paths.py

heitorlessa

It looks mostly great - only one-liner that could be more readable to ease maintenance by others.

Docs are lacking on confirming the two variants of object, as you pointed out - Amplify GraphQL Transformer vs AppSync Direct Lambda Resolvers.

Hopefully @awsed or @dabit3 have a few minutes to confirm whether there is a good complete event available for each in the docs somewhere

aws_lambda_powertools/utilities/data_classes/appsync_resolver_event.py

aws_lambda_powertools/utilities/data_classes/common.py

heitorlessa · 2021-03-10T18:34:58Z

Note to self - Validate how AppSync Direct Lambda resolvers event look like compared to what Amplify @function does. AppSync is unlikely to break contract while Amplify @function as at first glance it isn't formalized.

aws_lambda_powertools/utilities/data_classes/common.py

KoldBrewEd · 2021-03-10T20:36:42Z

This is a better event with the info object: https://github.com/aws/aws-sam-cli/blob/develop/samcli/lib/generated_sample_events/events/appsync/AppSyncDirectResolver.json

michaelbrewer · 2021-03-10T20:48:22Z

This is a better event with the info object: https://github.com/aws/aws-sam-cli/blob/develop/samcli/lib/generated_sample_events/events/appsync/AppSyncDirectResolver.json

Thanks @awsed i will add that to the test suite, interesting how it differs from what Amplify generates.

KoldBrewEd · 2021-03-10T20:54:13Z

@michaelbrewer the info object is missing, check line 60 here https://github.com/aws/aws-sam-cli/blob/ab3dcfae17f971cfbfea3f459ed872ba14cead83/samcli/lib/generated_sample_events/events/appsync/AppSyncDirectResolver.json#L60

michaelbrewer · 2021-03-10T20:59:12Z

@michaelbrewer the info object is missing, check line 60 here https://github.com/aws/aws-sam-cli/blob/ab3dcfae17f971cfbfea3f459ed872ba14cead83/samcli/lib/generated_sample_events/events/appsync/AppSyncDirectResolver.json#L60

yes, that does not come through for Amplify AppSync events.

michaelbrewer · 2021-03-10T22:12:09Z

@heitorlessa can you run through this again

@awsed - i have added all of the optional fields that might be in direct appsync calls.

Changes: * Add helper functions to generate GraphQL scalar types * AppSyncResolver decorator which works with AppSyncResolverEvent

michaelbrewer

@heitorlessa hopefully this is looking for merging

heitorlessa · 2021-03-12T14:01:23Z

Looking :) Is the PR description ready? I'll use that for the docs later

michaelbrewer · 2021-03-12T14:10:22Z

Looking :) Is the PR description ready? I'll use that for the docs later

The description progressed over time as i found more things. I can put in a checklist of changes. For the data-classes docs in general we could start to expand on the examples, but that could warrant a who cookbook section.

heitorlessa

Some suggestions on wording, a suggestion to follow what you did with Cognito data classes so including utils is cleaner, and a question on whether it's best to leave AppSyncResolver decorator out until we have a more complete written RFC for discussion?

Whatever we decide on AppSyncResolver will open precedent to discuss API Gateway Lightweight decorators too, for things like CORS, HTTP Methods, etc.

aws_lambda_powertools/utilities/data_classes/appsync_resolver_event.py

aws_lambda_powertools/utilities/data_classes/appsync_resolver_utils.py

docs/utilities/data_classes.md

heitorlessa · 2021-03-12T15:03:54Z

tests/functional/appsync/test_appsync_resolver_utils.py

+    app = AppSyncResolver()
+
+    @app.resolver(field_name="createSomething", include_context=True)


I wonder if this would be considered a Dataclass. I see two options:

Discuss some design options in a RFC for lightweight API handling

Expand Event Source Data Classes description to include utilities in it - Current description:The event source data classes utility provides classes describing the schema of common Lambda events triggers.

The first is my preference as we might find other use cases, UX, as we put this into written form.

@heitorlessa kind of started that here:
#324

But yes, in general having lightweight decorators help. Maybe like the SQS batch processing?

It's missing the RFC body like summary, drawbacks, alternatives, etc ;) one step a time

aws_lambda_powertools/utilities/data_classes/appsync_resolver_utils.py

Co-authored-by: Heitor Lessa <[email protected]>

…solver_event.py Co-authored-by: Heitor Lessa <[email protected]>

michaelbrewer · 2021-03-12T15:34:47Z

Some suggestions on wording, a suggestion to follow what you did with Cognito data classes so including utils is cleaner, and a question on whether it's best to leave AppSyncResolver decorator out until we have a more complete written RFC for discussion?

Whatever we decide on AppSyncResolver will open precedent to discuss API Gateway Lightweight decorators too, for things like CORS, HTTP Methods, etc.

I was thinking of leaving it as an undocumented or beta feature (but i will feature restructure the locations)

heitorlessa

After some thought, let's leave it as-is AppSyncResolver() and undocumented.

We can document that later once that RFC is written. That way, we add AppSync support within the data class, and have a good initial draft implementation of an AppSync Resolver ready to go once we find a better home for it.

To account for the utils() bit in AppSync data class, please make those changes in the Event Source Data Classes top description to include utilities too, so it doesn't get ruled out of scope for anything beyond a schema like this now

heitorlessa

Great, thank you!! I'll merge it as soon as the top text in the Data classes change to increase its scope to support utilities for event sources

heitorlessa · 2021-03-12T16:34:54Z

tests/functional/appsync/test_appsync_resolver_utils.py

+    app = AppSyncResolver()
+
+    @app.resolver(field_name="createSomething", include_context=True)


It's missing the RFC body like summary, drawbacks, alternatives, etc ;) one step a time

Michael Brewer added 4 commits March 10, 2021 01:33

feat(data-classes): AppSync Resolver Event

1fa4650

feat(data-classes): export AppSyncResolverEvent

3bfc9cd

chore: Correct the import

8583e7a

chore: Fix name

0cec3e1

heitorlessa added area/utilities feature New feature or functionality labels Mar 10, 2021

feat(data-classes): Add get_header_value function

35012f5

feat(data-classes): Add AppSyncIdentityCognito

d3ecf01

heitorlessa reviewed Mar 10, 2021

View reviewed changes

aws_lambda_powertools/utilities/data_classes/appsync_resolver_event.py Show resolved Hide resolved

Michael Brewer added 2 commits March 10, 2021 09:22

tests(data-classes): Add test_get_identity_object_iam

bc0e205

feat(logging): Add correlation path for APP_SYNC_RESOLVER

522a02a

heitorlessa reviewed Mar 10, 2021

View reviewed changes

aws_lambda_powertools/logging/correlation_paths.py Outdated Show resolved Hide resolved

heitorlessa suggested changes Mar 10, 2021

View reviewed changes

chore: Code review changes

6d960eb

feat(data-classes): Add AppSyncResolverEventInfo

789d5db

michaelbrewer requested a review from heitorlessa March 10, 2021 19:52

michaelbrewer commented Mar 10, 2021

View reviewed changes

aws_lambda_powertools/utilities/data_classes/common.py Show resolved Hide resolved

Michael Brewer added 2 commits March 10, 2021 12:56

fix(logging): Correct paths for AppSync

c3fa117

tests(data-classes): Add test_appsync_resolver_direct

006eeff

Michael Brewer added 3 commits March 10, 2021 12:59

docs(data-classes): Add AppSync Resolver docs

cf26506

chore: bump ci

0920999

feat(data-classes): Add AppSyncResolverEvent.stash

81346b9

Michael Brewer added 5 commits March 11, 2021 19:35

feat(data-classes): Add AppSync resolver utilities

6137896

Changes: * Add helper functions to generate GraphQL scalar types * AppSyncResolver decorator which works with AppSyncResolverEvent

feat(data-classes): Include include_event and include_context

7c5b6e9

tests(data-clasess): Verify async and yield works

87fb848

test(data-classes): only run async test on new python versions

fc03fdd

test(data-classes): Verify we can support multiple mappings

3875d2f

michaelbrewer commented Mar 12, 2021

View reviewed changes

heitorlessa self-assigned this Mar 12, 2021

heitorlessa suggested changes Mar 12, 2021

View reviewed changes

Michael Brewer and others added 5 commits March 12, 2021 07:26

chore: Update docs/utilities/data_classes.md

d17eada

Co-authored-by: Heitor Lessa <[email protected]>

chore: Update docs/utilities/data_classes.md

092f51b

Co-authored-by: Heitor Lessa <[email protected]>

chore: Update aws_lambda_powertools/utilities/data_classes/appsync_re…

8d8fe4a

…solver_event.py Co-authored-by: Heitor Lessa <[email protected]>

chore: Correct docs

1bfdbfb

chore: Correct docs

2c148ad

Michael Brewer added 2 commits March 12, 2021 07:41

refactor(data-classes): AppSync location

9315f81

docs(data-classes): Added sample usage

8ba4495

heitorlessa suggested changes Mar 12, 2021

View reviewed changes

chore: fix docs rendering

9562008

heitorlessa added this to the 1.12.0 milestone Mar 12, 2021

refactor: Remove docstrings and relocate data class

d1cde30

heitorlessa approved these changes Mar 12, 2021

View reviewed changes

docs(data-classes): Expanded on the scope and named app.py consistently

445f626

heitorlessa merged commit 34c2fa9 into aws-powertools:develop Mar 12, 2021

michaelbrewer deleted the feat-appsync-resolver-event branch March 12, 2021 17:43

aminalaee mentioned this pull request Nov 14, 2024

Maintenance: AppSyncResolverEvent uses typeName instead of parentTypeName #5560

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(data-classes): AppSync Resolver Event #323

feat(data-classes): AppSync Resolver Event #323

michaelbrewer commented Mar 10, 2021 •

edited

Loading

codecov-io commented Mar 10, 2021 •

edited

Loading

heitorlessa commented Mar 10, 2021

heitorlessa left a comment

heitorlessa commented Mar 10, 2021

KoldBrewEd commented Mar 10, 2021

michaelbrewer commented Mar 10, 2021

KoldBrewEd commented Mar 10, 2021

michaelbrewer commented Mar 10, 2021

michaelbrewer commented Mar 10, 2021

michaelbrewer left a comment

heitorlessa commented Mar 12, 2021

michaelbrewer commented Mar 12, 2021

heitorlessa left a comment

heitorlessa Mar 12, 2021

michaelbrewer Mar 12, 2021

heitorlessa Mar 12, 2021

michaelbrewer commented Mar 12, 2021

heitorlessa left a comment

heitorlessa left a comment

heitorlessa Mar 12, 2021

		app = AppSyncResolver()

		@app.resolver(field_name="createSomething", include_context=True)

feat(data-classes): AppSync Resolver Event #323

feat(data-classes): AppSync Resolver Event #323

Conversation

michaelbrewer commented Mar 10, 2021 • edited Loading

Description of changes:

codecov-io commented Mar 10, 2021 • edited Loading

Codecov Report

heitorlessa commented Mar 10, 2021

heitorlessa left a comment

Choose a reason for hiding this comment

heitorlessa commented Mar 10, 2021

KoldBrewEd commented Mar 10, 2021

michaelbrewer commented Mar 10, 2021

KoldBrewEd commented Mar 10, 2021

michaelbrewer commented Mar 10, 2021

michaelbrewer commented Mar 10, 2021

michaelbrewer left a comment

Choose a reason for hiding this comment

heitorlessa commented Mar 12, 2021

michaelbrewer commented Mar 12, 2021

heitorlessa left a comment

Choose a reason for hiding this comment

heitorlessa Mar 12, 2021

Choose a reason for hiding this comment

michaelbrewer Mar 12, 2021

Choose a reason for hiding this comment

heitorlessa Mar 12, 2021

Choose a reason for hiding this comment

michaelbrewer commented Mar 12, 2021

heitorlessa left a comment

Choose a reason for hiding this comment

heitorlessa left a comment

Choose a reason for hiding this comment

heitorlessa Mar 12, 2021

Choose a reason for hiding this comment

michaelbrewer commented Mar 10, 2021 •

edited

Loading

codecov-io commented Mar 10, 2021 •

edited

Loading