feat(cdk): add AppSync GraphQLSchema and pipeline resolvers as hot swappable #27197

Amplifiyer · 2023-09-19T15:17:09Z

Add GraphQLSchema as another AppSync resource that can be hotswapped
For all AppSync resources, accept the change in S3 assets/files instead of just inline code as a candidate for hotswap
Make pipeline resolvers hotswappable by resolving the functionId of AppSync functions.

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

…t swappable

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.

comcalvi

looks really good, overall!

comcalvi · 2023-09-20T21:53:57Z

packages/aws-cdk/lib/api/hotswap/appsync-mapping-templates.ts

        };
        const evaluatedResourceProperties = await evaluateCfnTemplate.evaluateCfnExpression(sdkProperties);
        const sdkRequestObject = transformObjectKeys(evaluatedResourceProperties, lowerCaseFirstCharacter);

+        // resolve s3 location files as SDK doesn't take in s3 location but inline code
+        if (sdkRequestObject.requestMappingTemplateS3Location) {
+          sdkRequestObject.requestMappingTemplate = (await fetchFileFromS3(sdkRequestObject.requestMappingTemplateS3Location, sdk))?.toString('utf8');


What does the user flow look like with any of the *S3Location properties? The MappingTemplate doesn't support an S3 location, and it also doesn't use it under the hood.

Even if it was supported, the user would have to change the s3 location for hotswap to be able to see it, not the object itself; diff will only detect a change in the object's location, not its contents. Users won't want to rename the object every time they make a change to it.

Tagging @alharris-at for more details. I believe we are using L1 CFN resource here and manually managing the requestMappingTemplateS3Location properties from our L3 data construct. (Don't know if it's the right reference https://github.com/aws-amplify/amplify-category-api/blob/c6772cfb9c0c68d6de4c04aa8190489fba0557a9/packages/graphql-transformer-core/src/util/SchemaResourceUtil.ts#L37)

In my testing, when updating high level amplify schema that results in a resolver change, I found only *S3Location properties to have changed. @alharris-at can you provide more details here?

Because Synth produces assets with a hash in the filename, I think the S3Location will change if a resolver or function's code is updated, and yeah we use L1 constructs here.

@comcalvi not urgent, but we might actually want to open the discussion to using S3Location instead of the inline approach for the L2 (when a file is provided), since that means customers will far more quickly hit Cfn template size limits (we see this happen for Amplify customers w/o inlining much of these assets, since with AppSync it's easy to produce a large number of resources quickly, and if we're inlining all code then it's going to expand very quickly).

ahh okay, so the s3 locations are managed through the CDK here. That makes sense, thanks for clarifying.

comcalvi · 2023-09-20T21:56:09Z

packages/aws-cdk/lib/api/hotswap/appsync-mapping-templates.ts

+          await simpleRetry(
+            () => sdk.appsync().updateFunction({ ...sdkRequestObject, functionId: functionId! }).promise(),
+            3,
+            'ConcurrentModificationException');


This is a good workaround for the orchestration / resource dependency problem, nice work

comcalvi · 2023-09-20T22:00:05Z

packages/aws-cdk/lib/api/hotswap/appsync-mapping-templates.ts

+        } else {
+          let schemaCreationResponse: GetSchemaCreationStatusResponse = await sdk.appsync().startSchemaCreation(sdkRequestObject).promise();
+          while (schemaCreationResponse.status && ['PROCESSING', 'DELETING'].some(status => status === schemaCreationResponse.status)) {
+            await new Promise(resolve => setTimeout(resolve, 1000)); // poll every second


can you make a little helper for this, similar to: https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk/lib/util/archive.ts#L84

Good idea, updated.

packages/aws-cdk/lib/api/hotswap/appsync-mapping-templates.ts

alharris-at · 2023-09-27T22:18:59Z

@Amplifiyer - looks like this doesn't support code props yet. Is that tracked in a separate PR, or is there a good reason to separate out? Seems like a the change will have significant overlap w/ the updates to S3Locatio, etc.

Amplifiyer · 2023-09-27T22:24:49Z

@Amplifiyer - looks like this doesn't support code props yet. Is that tracked in a separate PR, or is there a good reason to separate out? Seems like a the change will have significant overlap w/ the updates to S3Locatio, etc.

@alharris-at, ~~Yes I intend to add the Code in a follow up PR. Can you expand on what the overlap you mentioned here?~~ Nvm, it was pretty easy to just add it to this one.

aws-cdk-automation · 2023-09-28T16:51:05Z

➡️ PR build request submitted to test-main-pipeline ⬅️

A maintainer must now check the pipeline and add the pr-linter/cli-integ-tested label once the pipeline succeeds.

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

mergify · 2023-09-28T20:49:31Z

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 · 2023-09-28T21:16:45Z

AWS CodeBuild CI Report

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

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

mergify · 2023-09-28T21:17:05Z

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).

Amplifiyer changed the title ~~feat(aws-cdk): add AppSync GraphQLSchema and pipeline resolvers as hot swappable~~ feat(cdk): add AppSync GraphQLSchema and pipeline resolvers as hot swappable Sep 19, 2023

aws-cdk-automation requested a review from a team September 19, 2023 15:17

github-actions bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2 labels Sep 19, 2023

feat(aws-cdk): add AppSync GraphQLSchema and pipeline resolvers as ho…

4e209c3

…t swappable

Amplifiyer force-pushed the appsync__hotswap branch from 23ca8d0 to 4e209c3 Compare September 19, 2023 15:17

Amplifiyer had a problem deploying to test-pipeline September 19, 2023 15:18 — with GitHub Actions Failure

aws-cdk-automation previously requested changes Sep 19, 2023

View reviewed changes

aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Sep 19, 2023

update readme

8ec132c

Amplifiyer had a problem deploying to test-pipeline September 19, 2023 15:34 — with GitHub Actions Failure

comcalvi requested changes Sep 20, 2023

View reviewed changes

comcalvi self-assigned this Sep 20, 2023

PR updates

8d472c2

Amplifiyer had a problem deploying to test-pipeline September 21, 2023 13:58 — with GitHub Actions Failure

Amplifiyer marked this pull request as ready for review September 21, 2023 18:17

Add js resolver updates

f5c6e9f

Amplifiyer temporarily deployed to test-pipeline September 28, 2023 11:49 — with GitHub Actions Inactive

comcalvi added the pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested label Sep 28, 2023

aws-cdk-automation removed the pr/needs-cli-test-run This PR needs CLI tests run against it. label Sep 28, 2023

comcalvi approved these changes Sep 28, 2023

View reviewed changes

comcalvi added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Sep 28, 2023

Merge branch 'main' into appsync__hotswap

7dabd1c

mergify bot had a problem deploying to test-pipeline September 28, 2023 20:50 Failure

mergify bot merged commit 0ea6313 into aws:main Sep 28, 2023
8 of 9 checks passed

github-actions bot mentioned this pull request Oct 1, 2023

Monthly PRs metrics report - Sep 2023 #27368

Closed

tmokmss mentioned this pull request Sep 3, 2024

cli: hotswap support for AWS::Bedrock::Agent #31296

Open

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cdk): add AppSync GraphQLSchema and pipeline resolvers as hot swappable #27197

feat(cdk): add AppSync GraphQLSchema and pipeline resolvers as hot swappable #27197

Amplifiyer commented Sep 19, 2023

aws-cdk-automation left a comment

comcalvi left a comment

comcalvi Sep 20, 2023

Amplifiyer Sep 21, 2023

alharris-at Sep 27, 2023 •

edited

Loading

comcalvi Sep 28, 2023

comcalvi Sep 20, 2023 •

edited

Loading

comcalvi Sep 20, 2023

Amplifiyer Sep 21, 2023

alharris-at commented Sep 27, 2023

Amplifiyer commented Sep 27, 2023 •

edited

Loading

aws-cdk-automation commented Sep 28, 2023

mergify bot commented Sep 28, 2023

aws-cdk-automation commented Sep 28, 2023

mergify bot commented Sep 28, 2023

feat(cdk): add AppSync GraphQLSchema and pipeline resolvers as hot swappable #27197

feat(cdk): add AppSync GraphQLSchema and pipeline resolvers as hot swappable #27197

Conversation

Amplifiyer commented Sep 19, 2023

aws-cdk-automation left a comment

Choose a reason for hiding this comment

comcalvi left a comment

Choose a reason for hiding this comment

comcalvi Sep 20, 2023

Choose a reason for hiding this comment

Amplifiyer Sep 21, 2023

Choose a reason for hiding this comment

alharris-at Sep 27, 2023 • edited Loading

Choose a reason for hiding this comment

comcalvi Sep 28, 2023

Choose a reason for hiding this comment

comcalvi Sep 20, 2023 • edited Loading

Choose a reason for hiding this comment

comcalvi Sep 20, 2023

Choose a reason for hiding this comment

Amplifiyer Sep 21, 2023

Choose a reason for hiding this comment

alharris-at commented Sep 27, 2023

Amplifiyer commented Sep 27, 2023 • edited Loading

aws-cdk-automation commented Sep 28, 2023

mergify bot commented Sep 28, 2023

aws-cdk-automation commented Sep 28, 2023

AWS CodeBuild CI Report

mergify bot commented Sep 28, 2023

alharris-at Sep 27, 2023 •

edited

Loading

comcalvi Sep 20, 2023 •

edited

Loading

Amplifiyer commented Sep 27, 2023 •

edited

Loading