fix: update gql v2 custom transformer loading logic (#9252)

* fix: update gql v2 custom transformer loading logic

* test: add custom transformer v2 test

Co-authored-by: Colin Ihrig <colihrig@amazon.com>

packages/amplify-e2e-core/src/utils/transformConfig.ts

@@ -6,3 +6,9 @@ export function getTransformConfig(projectRoot: string, apiName: string): Transf
   const metaFilePath = path.join(projectRoot, 'amplify', 'backend', 'api', apiName, TRANSFORM_CONFIG_FILE_NAME);
   return <TransformConfig>JSON.parse(fs.readFileSync(metaFilePath, 'utf8'));
 }
+
+export function setTransformConfig(projectRoot: string, apiName: string, config) {
+  const metaFilePath = path.join(projectRoot, 'amplify', 'backend', 'api', apiName, TRANSFORM_CONFIG_FILE_NAME);
+
+  fs.writeFileSync(metaFilePath, JSON.stringify(config, null, 2));
+}

packages/amplify-e2e-tests/package.json

@@ -23,6 +23,7 @@
     "clean-e2e-resources": "ts-node ./src/cleanup-e2e-resources.ts"
   },
   "dependencies": {
+    "@aws-amplify/graphql-transformer-core": "0.15.0",
     "amplify-cli-core": "2.4.3",
     "amplify-e2e-core": "2.4.5",
     "aws-amplify": "^4.2.8",

packages/amplify-e2e-tests/schemas/custom_transformers/simple_custom_model.graphql

@@ -0,0 +1,4 @@
+type Todo @model @simple {
+  id: ID!
+  content: String
+}

packages/amplify-e2e-tests/schemas/custom_transformers/simple_custom_transformer.js

@@ -0,0 +1,11 @@
+const { TransformerPluginBase } = require('@aws-amplify/graphql-transformer-core');
+
+class SimpleCustomTransformer extends TransformerPluginBase {
+  constructor() {
+    super('simple-custom-transformer', 'directive @simple on OBJECT');
+  }
+
+  object() {} // Must be implemented.
+}
+
+module.exports = { default: SimpleCustomTransformer };

packages/amplify-e2e-tests/src/__tests__/graphql-v2/custom-transformers.test.ts

@@ -0,0 +1,63 @@
+import {
+  addApiWithoutSchema,
+  apiGqlCompile,
+  createNewProjectDir,
+  deleteProject,
+  deleteProjectDir,
+  getSchemaPath,
+  getTransformConfig,
+  initJSProjectWithProfile,
+  setTransformConfig,
+  updateApiSchema,
+} from 'amplify-e2e-core';
+import * as path from 'path';
+
+describe('GraphQL transformer v2 - Custom transformers', () => {
+  let projRoot: string;
+  let projFolderName: string;
+
+  beforeEach(async () => {
+    projFolderName = 'graphqlv2customtransformer';
+    projRoot = await createNewProjectDir(projFolderName);
+  });
+
+  afterEach(async () => {
+    try {
+      await deleteProject(projRoot);
+    } catch (_) {
+      // No-op.
+    }
+
+    deleteProjectDir(projRoot);
+  });
+
+  it('create a project including a custom transformer', async () => {
+    const projName = 'v2customtransformer';
+    const schemaDir = 'custom_transformers';
+    const schemaFile = 'simple_custom_model.graphql';
+    const schemaName = path.join(schemaDir, schemaFile);
+    const schemaPath = getSchemaPath(schemaName);
+    const customTransformerName = 'simple_custom_transformer.js';
+    const customTransformerPath = schemaPath.replace(schemaFile, customTransformerName);
+
+    await initJSProjectWithProfile(projRoot, { name: projName });
+    await addApiWithoutSchema(projRoot);
+    await updateApiSchema(projRoot, projName, schemaName);
+
+    // GQL compile should fail initially because the transformer does
+    // not know about the custom directive.
+    await expect(async () => {
+      await apiGqlCompile(projRoot);
+    }).rejects.toThrow();
+
+    // Add the custom directive.
+    const config = getTransformConfig(projRoot, projName);
+    config.transformers ??= [];
+    config.transformers.push(customTransformerPath);
+    setTransformConfig(projRoot, projName, config);
+
+    // GQL compile should pass now because the transformer knows about
+    // the custom directive.
+    await apiGqlCompile(projRoot);
+  });
+});

packages/amplify-graphql-transformer-core/src/config/project-config.ts

@@ -13,6 +13,4 @@ export interface TransformerProjectConfig {
   resolvers: Record<string, string>;
   stacks: Record<string, Template>;
   config: TransformConfig;
-  // Custom transformer plugins
-  transformers?: string[];
 }

packages/amplify-graphql-transformer-core/src/config/transformer-config.ts

@@ -62,4 +62,7 @@ export interface TransformConfig {
       [option: string]: any;
     };
   };
+
+  // Custom transformer plugins
+  transformers?: string[];
 }

packages/amplify-provider-awscloudformation/src/graphql-transformer/transform-graphql-schema.ts

@@ -108,9 +108,8 @@ function getTransformerFactory(
     }
 
     const customTransformersConfig = await readTransformerConfiguration(resourceDir);
-    const customTransformers = (
-      customTransformersConfig && customTransformersConfig.transformers ? customTransformersConfig.transformers : []
-    )
+    const customTransformerList = customTransformersConfig?.config?.transformers;
+    const customTransformers = (Array.isArray(customTransformerList) ? customTransformerList : [])
       .map(transformer => {
         const fileUrlMatch = /^file:\/\/(.*)\s*$/m.exec(transformer);
         const modulePath = fileUrlMatch ? fileUrlMatch[1] : transformer;