feat: migrate index and model transformers to CDK v2 #860

sobolk · 2022-10-06T16:03:08Z

Description of changes

This PR makes the following packages compile with CDK v2.

@aws-amplify/graphql-index-transformer
@aws-amplify/graphql-model-transformer
@aws-amplify/graphql-transformer-core
@aws-amplify/graphql-transformer-interfaces

Issue #, if available

Description of how you validated changes

This PR compiles and passes yarn test, however we won't be able to run e2e tests until we migrate whole category.
See https://app.circleci.com/pipelines/github/aws-amplify/amplify-category-api/1412/workflows/79a728ce-2ecd-4822-ae15-35e5ee32cfb0

src/__tests__/BelongsToTransformerV2.e2e.test.ts(49,69): error TS2345: Argument of type '() => import("/Users/sobkamil/git/amplify-category-api/packages/amplify-graphql-auth-transformer/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/transform").GraphQLTransform' is not assignable to parameter of type '() => import("/Users/sobkamil/git/amplify-category-api/packages/amplify-graphql-transformer-core/lib/transformation/transform").GraphQLTransform'.
  Type 'import("/Users/sobkamil/git/amplify-category-api/packages/amplify-graphql-auth-transformer/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/transform").GraphQLTransform' is not assignable to type 'import("/Users/sobkamil/git/amplify-category-api/packages/amplify-graphql-transformer-core/lib/transformation/transform").GraphQLTransform'.
    Types have separate declarations of a private property 'options'.
src/__tests__/MapsToTransformer.e2e.test.ts(57,64): error TS2345: Argument of type '() => import("/Users/sobkamil/git/amplify-category-api/packages/amplify-graphql-auth-transformer/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/transform").GraphQLTransform' is not assignable to parameter of type '() => import("/Users/sobkamil/git/amplify-category-api/packages/amplify-graphql-transformer-core/lib/transformation/transform").GraphQLTransform'.
  Type 'import("/Users/sobkamil/git/amplify-category-api/packages/amplify-graphql-auth-transformer/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/transform").GraphQLTransform' is not assignable to type 'import("/Users/sobkamil/git/amplify-category-api/packages/amplify-graphql-transformer-core/lib/transformation/transform").GraphQLTransform'.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Checklist

PR description included
yarn test passes

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

sobolk · 2022-10-06T16:06:17Z

...raphql-model-transformer/src/__tests__/__snapshots__/model-transformer-override.test.ts.snap

@@ -237,7 +237,7 @@ $util.qr($ctx.stash.metadata.put(\\"apiId\\", \\"",
              "\\"))
 $util.qr($ctx.stash.put(\\"tableName\\", \\"",
              Object {
-                "Ref": "PostTable",


Follow up: figure out if changing name like this is ok.
https://app.asana.com/0/1202389680978480/1203117329609220/f

…sformer-to-cdk-v2

lgtm-com · 2022-10-06T16:22:00Z

This pull request introduces 1 alert when merging 30760ce into b3cb9ae - view on LGTM.com

new alerts:

1 for Unused variable, import, function or class

…import

…n e2e tests.

sobolk · 2022-10-06T17:18:43Z

packages/amplify-e2e-tests/package.json

@@ -24,7 +24,7 @@
    "clean-stale-test-buckets": "ts-node ./src/cleanup-stale-test-buckets.ts"
  },
  "dependencies": {
-    "@aws-amplify/graphql-transformer-core": "0.17.12",
+    "@aws-amplify/graphql-transformer-core": "1.0.0",


Until we migrate everything we end up with:

$ yarn tsc --build tsconfig.tests.json $ /home/circleci/repo/node_modules/.bin/tsc --build tsconfig.tests.json src/__tests__/BelongsToTransformerV2.e2e.test.ts(49,69): error TS2345: Argument of type '() => import("/home/circleci/repo/packages/amplify-graphql-auth-transformer/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/transform").GraphQLTransform' is not assignable to parameter of type '() => import("/home/circleci/repo/packages/amplify-graphql-transformer-core/lib/transformation/transform").GraphQLTransform'. Type 'import("/home/circleci/repo/packages/amplify-graphql-auth-transformer/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/transform").GraphQLTransform' is not assignable to type 'import("/home/circleci/repo/packages/amplify-graphql-transformer-core/lib/transformation/transform").GraphQLTransform'. Types have separate declarations of a private property 'options'. src/__tests__/MapsToTransformer.e2e.test.ts(57,64): error TS2345: Argument of type '() => import("/home/circleci/repo/packages/amplify-graphql-auth-transformer/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/transform").GraphQLTransform' is not assignable to parameter of type '() => import("/home/circleci/repo/packages/amplify-graphql-transformer-core/lib/transformation/transform").GraphQLTransform'. Type 'import("/home/circleci/repo/packages/amplify-graphql-auth-transformer/node_modules/@aws-amplify/graphql-transformer-core/lib/transformation/transform").GraphQLTransform' is not assignable to type 'import("/home/circleci/repo/packages/amplify-graphql-transformer-core/lib/transformation/transform").GraphQLTransform'. info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

sobolk · 2022-10-06T18:01:33Z

packages/amplify-graphql-transformer-interfaces/src/graphql-api-provider.ts

@@ -110,7 +113,7 @@ export interface S3MappingFunctionCodeProvider {

 export type MappingTemplateProvider = InlineMappingTemplateProvider | S3MappingTemplateProvider;

-export interface GraphQLAPIProvider {
+export interface GraphQLAPIProvider extends IConstruct {


IConstruct got node property in latest version and compiler was unhappy about us passing GraphQLAPIProvider as a construct.

@alharris-at I have not explored what does this mean to add node prop to GraphQLAPIProvider just added IConstruct as a parent since we use GraphQLAPIProvider as a construct - is this right direction? I.e. did we think about GraphQLAPIProvider as a construct or not?

Here

amplify-category-api/packages/amplify-graphql-transformer-core/src/graphql-api.ts

Lines 106 to 107 in b96ca09

public resourceArns(api: GraphQLAPIProvider): string[] {

return this.arns.map(arn => Stack.of(api).formatArn({

akshbhu · 2022-10-07T17:39:06Z

packages/amplify-graphql-index-transformer/package.json

    "graphql": "^14.5.8",
    "graphql-mapping-template": "4.20.5",
    "graphql-transformer-common": "4.24.0"
  },
  "devDependencies": {
-    "@aws-cdk/assert": "~1.124.0"
+    "@aws-cdk/assert": "~2.41.0"


Doesn't it comes under 'aws-cdk-lib' ?

It doesn't. It's a testing library. It's expected that this will be separate package.
However, now that I'm looking at https://www.npmjs.com/package/@aws-cdk/assert it says it's deprecated. I'll take a look at what's best option here.

thereis this : https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions-readme.html

So this is indeed part of core package. I'll work on this then. thanks!

akshbhu · 2022-10-07T17:47:27Z

packages/amplify-graphql-transformer-core/src/cdk-compat/stack-synthesizer.ts

@@ -79,7 +79,7 @@ export class TransformerStackSythesizer extends LegacyStackSynthesizer {
    const s3ObjectUrl = `s3://${bucketName}/${rootKey}/${asset.fileName}`;

    return {
-      bucketName, objectKey, httpUrl, s3ObjectUrl, s3Url: httpUrl,
+      bucketName, objectKey, httpUrl, s3ObjectUrl,


Is this a lint fix ?

No. CDK removed that parameter. It was deprecated and is redundant with httpUrl.

akshbhu · 2022-10-07T17:51:38Z

...raphql-model-transformer/src/__tests__/__snapshots__/model-transformer-override.test.ts.snap

+                    "CommentTableE9F84112",
                    "Arn",


Is the new construct creating new logicalIds for ddbTable?
That can create problem

I logged a follow up to investigate this when we get to a stage when we can run e2e workflows (tests and manual). https://app.asana.com/0/1202389680978480/1203117329609220/f .
The name isn't pretty but might be ok given that it's consistent change across the whole file.

sobolk · 2022-10-10T17:12:03Z

...es/amplify-graphql-index-transformer/src/__tests__/amplify-graphql-index-transformer.test.ts

@@ -7,7 +7,7 @@ import {
  Template,
 } from '@aws-amplify/graphql-transformer-core';
 import { FeatureFlagProvider } from '@aws-amplify/graphql-transformer-interfaces';
-import { expect as cdkExpect, haveResourceLike } from '@aws-cdk/assert';
+import { Template as AssertionTemplate } from 'aws-cdk-lib/assertions';


name collision.

sobolk · 2022-10-10T17:13:59Z

packages/amplify-graphql-maps-to-transformer/package.json

@@ -40,6 +40,7 @@
  },
  "devDependencies": {
    "@aws-amplify/graphql-model-transformer": "0.16.0",
+    "@aws-amplify/graphql-index-transformer": "0.14.0",


there's index transformer usage in the with-many-to-many.test.ts . Magically latest version from build was picked up so adding this here for 1. completeness 2. to not bloat this PR with one more transformer.

feat: migrate index and model transformers to CDK v2

087abc3

sobolk commented Oct 6, 2022

View reviewed changes

Merge remote-tracking branch 'upstream/cdkv2' into migrate-index-tran…

30760ce

…sformer-to-cdk-v2

sobolk added 3 commits October 6, 2022 09:25

feat: migrate index and model transformers to CDK v2 - undo lint

3c2078f

feat: migrate index and model transformers to CDK v2 - remove unused …

8aca01d

…import

feat: migrate index and model transformers to CDK v2 - bump version i…

1b8eaef

…n e2e tests.

sobolk commented Oct 6, 2022

View reviewed changes

sobolk marked this pull request as ready for review October 6, 2022 17:53

sobolk requested a review from a team as a code owner October 6, 2022 17:53

sobolk commented Oct 6, 2022

View reviewed changes

sobolk requested review from akshbhu and alharris-at October 6, 2022 18:01

akshbhu reviewed Oct 7, 2022

View reviewed changes

feat: migrate index and model transformers to CDK v2 - pr feedback.

9d67c11

sobolk commented Oct 10, 2022

View reviewed changes

alharris-at approved these changes Oct 10, 2022

View reviewed changes

alharris-at merged commit 886ab6c into aws-amplify:cdkv2 Oct 10, 2022

sobolk mentioned this pull request Oct 18, 2022

fix: resolution of nested stack template url #893

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: migrate index and model transformers to CDK v2 #860

feat: migrate index and model transformers to CDK v2 #860

sobolk commented Oct 6, 2022 •

edited by alharris-at

Loading

sobolk Oct 6, 2022 •

edited

Loading

lgtm-com bot commented Oct 6, 2022

sobolk Oct 6, 2022 •

edited

Loading

sobolk Oct 6, 2022

akshbhu Oct 7, 2022

sobolk Oct 7, 2022

akshbhu Oct 7, 2022

sobolk Oct 7, 2022

akshbhu Oct 7, 2022

sobolk Oct 7, 2022

akshbhu Oct 7, 2022

sobolk Oct 7, 2022

sobolk Oct 10, 2022

sobolk Oct 10, 2022

	public resourceArns(api: GraphQLAPIProvider): string[] {
	return this.arns.map(arn => Stack.of(api).formatArn({

feat: migrate index and model transformers to CDK v2 #860

feat: migrate index and model transformers to CDK v2 #860

Conversation

sobolk commented Oct 6, 2022 • edited by alharris-at Loading

Description of changes

Issue #, if available

Description of how you validated changes

Checklist

sobolk Oct 6, 2022 • edited Loading

Choose a reason for hiding this comment

lgtm-com bot commented Oct 6, 2022

sobolk Oct 6, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sobolk commented Oct 6, 2022 •

edited by alharris-at

Loading

sobolk Oct 6, 2022 •

edited

Loading

sobolk Oct 6, 2022 •

edited

Loading