feat(appsync): queryDepthLimit and resolverCountLimit props on GraphqlApi by aerrober · Pull Request #29182 · aws/aws-cdk

aerrober · 2024-02-20T19:25:51Z

Issue # (if applicable)

No open issue. Cr was based on #28500

Reason for this change

Appsync added two additional fields documented in their CFN here that were not previously supported in the L1 construct.

Description of changes

Addition of field queryDepthLimit and resolverCountLimit

Description of how you validated changes

Unit tests and integration tests were run locally. Additionally a sample app was deployed to validate these features.

Checklist

[ x] My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

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

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

kaizencc

Thanks for the contribution @aerrober. Just some additions needed

kaizencc · 2024-02-21T18:30:46Z

packages/aws-cdk-lib/aws-appsync/README.md

+
+## Query Depth Limits
+
+There are times during which you may want more granular control over how the API functions during an operation. One such control is adding a limit to the amount of nested levels a query may process. By default, queries are able to process an unlimited amount of nested levels. Limiting queries to a specified amount of nested levels has potential implications for the performance and flexibility of your project.


please split this up into a sentence per line so the raw markdown is more amenable to look at.

kaizencc · 2024-02-21T18:30:51Z

packages/aws-cdk-lib/aws-appsync/README.md

+const api = new appsync.GraphqlApi(this, 'api', {
+  name: 'LimitQueryDepths',
+  definition: appsync.Definition.fromFile(path.join(__dirname, 'appsync.schema.graphql')),
+  queryDepthLimit: 2


Suggested change

queryDepthLimit: 2

queryDepthLimit: 2,

kaizencc · 2024-02-21T18:30:57Z

packages/aws-cdk-lib/aws-appsync/README.md

+const api = new appsync.GraphqlApi(this, 'api', {
+  name: 'LimitResolverCount',
+  definition: appsync.Definition.fromFile(path.join(__dirname, 'appsync.schema.graphql')),
+  resolverCountLimit: 2


Suggested change

resolverCountLimit: 2

resolverCountLimit: 2,

kaizencc · 2024-02-21T18:31:45Z

packages/aws-cdk-lib/aws-appsync/lib/graphqlapi.ts

+  /**
+   * A number indicating the maximum number of resolvers that should be accepted when handling queries.
+   *
+   * @default - No Limit


https://docs.aws.amazon.com/appsync/latest/APIReference/API_GraphqlApi.html

"The default value is 0 (or unspecified), which will set the limit to 10000"

kaizencc · 2024-02-21T18:32:33Z

packages/aws-cdk-lib/aws-appsync/lib/graphqlapi.ts

   * @default IntrospectionConfig.ENABLED
   */
  readonly introspectionConfig?: IntrospectionConfig;
+


both of these new props have lower and upper bounds according to the docs: https://docs.aws.amazon.com/appsync/latest/APIReference/API_GraphqlApi.html

They should be documented in their docstrings, checked for at synth time, and also have a unit test for each testing the boundary

Pull request has been modified.

aws-cdk-automation · 2024-02-25T00:09:41Z

This PR cannot be merged because it has conflicts. Please resolve them. The PR will be considered stale and closed if it remains in an unmergeable state.

aws-cdk-automation · 2024-02-26T00:09:15Z

This PR cannot be merged because it has conflicts. Please resolve them. The PR will be considered stale and closed if it remains in an unmergeable state.

mergify · 2024-03-18T14:13:41Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2024-03-18T14:17:46Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2024-03-18T15:09:55Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 85c2c9b
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2024-03-18T15:10:13Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

…lApi (aws#29182) ### Issue # (if applicable) No open issue. Cr was based on aws#28500 ### Reason for this change Appsync added two additional fields documented in their CFN [here](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-resolvercountlimit) that were not previously supported in the L1 construct. ### Description of changes Addition of field `queryDepthLimit` and `resolverCountLimit` ### Description of how you validated changes Unit tests and integration tests were run locally. Additionally a sample app was deployed to validate these features. ### Checklist - [ x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

feat(appsync): Support for queryDepthLimit and resolverCountLimit

eb34f26

aws-cdk-automation requested a review from a team February 20, 2024 19:26

github-actions bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2 labels Feb 20, 2024

aerrober had a problem deploying to test-pipeline February 20, 2024 19:27 — with GitHub Actions Failure

aws-cdk-automation previously requested changes Feb 20, 2024

View reviewed changes

aerrober changed the title ~~feat(appsync): Support for queryDepthLimit and resolverCountLimit~~ Support for queryDepthLimit and resolverCountLimit Feb 20, 2024

Merge branch 'main' into feat/appsync-limit-config

c97e6ca

aerrober changed the title ~~Support for queryDepthLimit and resolverCountLimit~~ feat(appsync): support for queryDepthLimit and resolverCountLimit Feb 20, 2024

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Feb 20, 2024

kaizencc previously requested changes Feb 21, 2024

View reviewed changes

kaizencc changed the title ~~feat(appsync): support for queryDepthLimit and resolverCountLimit~~ feat(appsync): queryDepthLimit and resolverCountLimit props on GraphqlApi Feb 21, 2024

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Feb 21, 2024

fixes for pr

0e82e7d

linting fixes

3664cdc

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Feb 21, 2024

aerrober added 2 commits February 26, 2024 09:12

Merge branch 'main' into feat/appsync-limit-config

5d98a06

linting fix

f3c8837

github-actions bot mentioned this pull request Mar 1, 2024

Monthly PR metrics report - Feb 2023 #29328

Closed

kaizencc approved these changes Mar 18, 2024

View reviewed changes

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Mar 18, 2024

Merge branch 'main' into feat/appsync-limit-config

85c2c9b

kaizencc approved these changes Mar 18, 2024

View reviewed changes

mergify bot merged commit ba6d0b3 into aws:main Mar 18, 2024

This was referenced May 23, 2024

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#98

Open

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#99

Open

NOUIY mentioned this pull request May 30, 2024

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#101

Open


		## Query Depth Limits

		There are times during which you may want more granular control over how the API functions during an operation. One such control is adding a limit to the amount of nested levels a query may process. By default, queries are able to process an unlimited amount of nested levels. Limiting queries to a specified amount of nested levels has potential implications for the performance and flexibility of your project.

Conversation

aerrober commented Feb 20, 2024

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

Uh oh!

aws-cdk-automation left a comment

Choose a reason for hiding this comment

Uh oh!

kaizencc left a comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aws-cdk-automation commented Feb 25, 2024

Uh oh!

aws-cdk-automation commented Feb 26, 2024

Uh oh!

mergify bot commented Mar 18, 2024

Uh oh!

mergify bot commented Mar 18, 2024

Uh oh!

aws-cdk-automation commented Mar 18, 2024

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Mar 18, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants