Fix e2e tests for pluralization (#7590)

Currently, we’re testing the iterative update by renaming the intial Todo model and updating it to Todos. Previously, this created a resolver called listTodoss (because it incorrectly blindly appended s). With the pluralization fix, it creates a resolver called listTodos - which unfortunately already exists and therefore appsync throws a Only one resolver is allowed per field error (aws/aws-appsync-community#128)
aws-amplify · Jun 24, 2021 · 1b01540 · 1b01540
1 parent 81659ee
commit 1b01540
Show file tree

Hide file tree

Showing 73 changed files with 1,002 additions and 206 deletions.
diff --git a/packages/amplify-category-api/src/commands/api/add-graphql-datasource.js b/packages/amplify-category-api/src/commands/api/add-graphql-datasource.js
@@ -5,8 +5,7 @@ const path = require('path');
 const { RelationalDBSchemaTransformer } = require('graphql-relational-schema-transformer');
 const { RelationalDBTemplateGenerator, AuroraServerlessMySQLDatabaseReader } = require('graphql-relational-schema-transformer');
 const { mergeTypeDefs } = require('@graphql-tools/merge');
-const { ResourceDoesNotExistError, exitOnNextTick } = require('amplify-cli-core');
-
+const { FeatureFlags, ResourceDoesNotExistError, exitOnNextTick } = require('amplify-cli-core');
 const subcommand = 'add-graphql-datasource';
 const categories = 'categories';
 const category = 'api';
@@ -143,7 +142,11 @@ module.exports = {
         context[rdsResourceName] = resourceName;
         context[rdsDatasource] = datasource;
         let template = templateGenerator.createTemplate(context);
-        template = templateGenerator.addRelationalResolvers(template, resolversDir);
+        template = templateGenerator.addRelationalResolvers(
+          template,
+          resolversDir,
+          FeatureFlags.getBoolean('graphqltransformer.improvePluralization'),
+        );
         const cfn = templateGenerator.printCloudformationTemplate(template);
 
         /**

diff --git a/packages/amplify-cli-core/src/feature-flags/featureFlags.ts b/packages/amplify-cli-core/src/feature-flags/featureFlags.ts
@@ -515,6 +515,12 @@ export class FeatureFlags {
         defaultValueForExistingProjects: false,
         defaultValueForNewProjects: true,
       },
+      {
+        name: 'improvePluralization',
+        type: 'boolean',
+        defaultValueForExistingProjects: false,
+        defaultValueForNewProjects: true,
+      },
       {
         name: 'validateTypeNameReservedWords',
         type: 'boolean',

diff --git a/packages/amplify-e2e-tests/schemas/iterative-push/change-model-name/final-schema.graphql b/packages/amplify-e2e-tests/schemas/iterative-push/change-model-name/final-schema.graphql
@@ -1,12 +1,12 @@
-type Comment @model @key(name: "byTodos", fields: ["todoID"]) {
+type Comment @model @key(name: "byTask", fields: ["todoID"]) {
   id: ID!
   todoID: ID!
 }
 
-type Todos @model {
+type Task @model {
   id: ID!
   name: String!
   description: String
   addfield2: String
-  Comments: [Comment] @connection(keyName: "byTodos", fields: ["id"])
+  Comments: [Comment] @connection(keyName: "byTask", fields: ["id"])
 }
diff --git a/packages/amplify-e2e-tests/src/schema-api-directives/tests/data-access-patterns.ts b/packages/amplify-e2e-tests/src/schema-api-directives/tests/data-access-patterns.ts
@@ -368,7 +368,7 @@ export const expected_result_query6 = {
 
 export const query7 = `
 ## 7. See all employees hired recently:
-#Having '@key(name: "newHire", fields: ["newHire", "id"])' on the 'Employee' model allows one to query by whether an employee has been hired recently. 
+#Having '@key(name: "newHire", fields: ["newHire", "id"])' on the 'Employee' model allows one to query by whether an employee has been hired recently.
 
 query employeesNewHire {
   employeesNewHire(newHire: "true") {
@@ -685,8 +685,8 @@ export const query16 = `
 ## 16. Get total product inventory:
 #How this would be done depends on the use case. If one just wants a list of all inventories in all warehouses, one could just run a list inventories on the Inventory model:
 
-query listInventorys {
-  listInventorys {
+query listInventories {
+  listInventories {
     items {
       productID
       warehouseID
@@ -696,7 +696,7 @@ query listInventorys {
 }`;
 export const expected_result_query16 = {
   data: {
-    listInventorys: {
+    listInventories: {
       items: [
         {
           productID: 'yeezyboost',

diff --git a/...phql-searchable-transformer/src/__tests__/amplify-graphql-searchable-transformer.tests.ts b/...phql-searchable-transformer/src/__tests__/amplify-graphql-searchable-transformer.tests.ts
@@ -3,6 +3,17 @@ import { SearchableModelTransformer } from '../';
 import { ModelTransformer } from '@aws-amplify/graphql-model-transformer';
 import { anything, countResources, expect as cdkExpect, haveResource } from '@aws-cdk/assert';
 import { parse } from 'graphql';
+const featureFlags = {
+  getBoolean: jest.fn().mockImplementation((name, defaultValue) => {
+    if (name === 'improvePluralization') {
+      return true;
+    }
+    return;
+  }),
+  getNumber: jest.fn(),
+  getObject: jest.fn(),
+  getString: jest.fn(),
+};
 
 test('Test SearchableModelTransformer validation happy case', () => {
   const validSchema = `
@@ -15,6 +26,7 @@ test('Test SearchableModelTransformer validation happy case', () => {
     `;
   const transformer = new GraphQLTransform({
     transformers: [new ModelTransformer(), new SearchableModelTransformer()],
+    featureFlags,
   });
   const out = transformer.transform(validSchema);
   expect(out).toBeDefined();
@@ -33,6 +45,7 @@ test('Test SearchableModelTransformer vtl', () => {
     `;
   const transformer = new GraphQLTransform({
     transformers: [new ModelTransformer(), new SearchableModelTransformer()],
+    featureFlags,
   });
 
   const out = transformer.transform(validSchema);
@@ -50,6 +63,7 @@ test('Test SearchableModelTransformer with query overrides', () => {
     `;
   const transformer = new GraphQLTransform({
     transformers: [new ModelTransformer(), new SearchableModelTransformer()],
+    featureFlags,
   });
   const out = transformer.transform(validSchema);
   expect(out).toBeDefined();
@@ -67,6 +81,7 @@ test('Test SearchableModelTransformer with only create mutations', () => {
     `;
   const transformer = new GraphQLTransform({
     transformers: [new ModelTransformer(), new SearchableModelTransformer()],
+    featureFlags,
   });
   const out = transformer.transform(validSchema);
   expect(out).toBeDefined();
@@ -90,6 +105,7 @@ test('Test SearchableModelTransformer with multiple model searchable directives'
     `;
   const transformer = new GraphQLTransform({
     transformers: [new ModelTransformer(), new SearchableModelTransformer()],
+    featureFlags,
   });
   const out = transformer.transform(validSchema);
   expect(out).toBeDefined();
@@ -108,6 +124,7 @@ test('Test SearchableModelTransformer with sort fields', () => {
     `;
   const transformer = new GraphQLTransform({
     transformers: [new ModelTransformer(), new SearchableModelTransformer()],
+    featureFlags,
   });
   const out = transformer.transform(validSchema);
   expect(out).toBeDefined();
@@ -137,6 +154,7 @@ test('it generates expected resources', () => {
  `;
   const transformer = new GraphQLTransform({
     transformers: [new ModelTransformer(), new SearchableModelTransformer()],
+    featureFlags,
   });
   const out = transformer.transform(validSchema);
   expect(out).toBeDefined();

diff --git a/packages/amplify-graphql-searchable-transformer/src/graphql-searchable-transformer.ts b/packages/amplify-graphql-searchable-transformer/src/graphql-searchable-transformer.ts
@@ -158,7 +158,9 @@ export class SearchableModelTransformer extends TransformerPluginBase {
         searchFieldNameOverride = directiveArguments.queries.search;
       }
     }
-    const fieldName = searchFieldNameOverride ? searchFieldNameOverride : graphqlName(`search${plurality(toUpper(definition.name.value))}`);
+    const fieldName = searchFieldNameOverride
+      ? searchFieldNameOverride
+      : graphqlName(`search${plurality(toUpper(definition.name.value), ctx.featureFlags.getBoolean('improvePluralization'))}`);
     this.searchableObjectTypeDefinitions.push({
       node: definition,
       fieldName,

diff --git a/packages/amplify-util-mock/src/__e2e__/connections-with-auth-tests.e2e.test.ts b/packages/amplify-util-mock/src/__e2e__/connections-with-auth-tests.e2e.test.ts
@@ -1,7 +1,7 @@
 import { ModelAuthTransformer } from 'graphql-auth-transformer';
 import { ModelConnectionTransformer } from 'graphql-connection-transformer';
 import { DynamoDBModelTransformer } from 'graphql-dynamodb-transformer';
-import { GraphQLTransform } from 'graphql-transformer-core';
+import { FeatureFlagProvider, GraphQLTransform } from 'graphql-transformer-core';
 import { signUpAddToGroupAndGetJwtToken } from './utils/cognito-utils';
 import { GraphQLClient } from './utils/graphql-client';
 import { deploy, launchDDBLocal, logDebug, terminateDDB } from './utils/index';
@@ -112,6 +112,9 @@ type Stage @model @auth(rules: [{ allow: groups, groups: ["Admin"]}]) {
         },
       }),
     ],
+    featureFlags: {
+      getBoolean: name => (name === 'improvePluralization' ? true : false),
+    } as FeatureFlagProvider,
   });
 
   try {

diff --git a/packages/amplify-util-mock/src/__e2e__/dynamo-db-model-transformer.e2e.test.ts b/packages/amplify-util-mock/src/__e2e__/dynamo-db-model-transformer.e2e.test.ts
@@ -1,6 +1,6 @@
 import { ModelAuthTransformer } from 'graphql-auth-transformer';
 import { DynamoDBModelTransformer } from 'graphql-dynamodb-transformer';
-import { GraphQLTransform } from 'graphql-transformer-core';
+import { FeatureFlagProvider, GraphQLTransform } from 'graphql-transformer-core';
 import { GraphQLClient } from './utils/graphql-client';
 import { deploy, launchDDBLocal, terminateDDB, logDebug } from './utils/index';
 
@@ -59,6 +59,9 @@ beforeAll(async () => {
           },
         }),
       ],
+      featureFlags: {
+        getBoolean: name => (name === 'improvePluralization' ? true : false),
+      } as FeatureFlagProvider,
     });
     const out = await transformer.transform(validSchema);
     let ddbClient;
@@ -179,27 +182,33 @@ test('Test createPost mutation', async () => {
 });
 
 test('Test query on get query with null field', async () => {
-  const createResponse = await GRAPHQL_CLIENT.query(`
+  const createResponse = await GRAPHQL_CLIENT.query(
+    `
     mutation {
       createPost(input: { title: "Cool Post" }) {
         id
         title
         createdAt
         updatedAt
       }
-    }`, {});
+    }`,
+    {},
+  );
   expect(createResponse.data.createPost.id).toBeDefined();
   expect(createResponse.data.createPost.title).toEqual('Cool Post');
   const postID = createResponse.data.createPost.id;
   try {
-    const queryResponse = await GRAPHQL_CLIENT.query(`
+    const queryResponse = await GRAPHQL_CLIENT.query(
+      `
     query {
       getPost(id: "${postID}") {
         id
         title
         episode
       }
-    }`, {});
+    }`,
+      {},
+    );
     expect(queryResponse.data.getPost.id).toEqual(postID);
     expect(queryResponse.data.getPost.episode).toBeNull();
   } catch (err) {

diff --git a/packages/amplify-util-mock/src/__e2e__/function-transformer.e2e.test.ts b/packages/amplify-util-mock/src/__e2e__/function-transformer.e2e.test.ts
@@ -1,6 +1,6 @@
 import { DynamoDBModelTransformer } from 'graphql-dynamodb-transformer';
 import { FunctionTransformer } from 'graphql-function-transformer';
-import { GraphQLTransform } from 'graphql-transformer-core';
+import { FeatureFlagProvider, GraphQLTransform } from 'graphql-transformer-core';
 import { GraphQLClient } from './utils/graphql-client';
 import { deploy, logDebug } from './utils/index';
 
@@ -36,6 +36,9 @@ beforeAll(async () => {
   try {
     const transformer = new GraphQLTransform({
       transformers: [new DynamoDBModelTransformer(), new FunctionTransformer()],
+      featureFlags: {
+        getBoolean: name => (name === 'improvePluralization' ? true : false),
+      } as FeatureFlagProvider,
     });
     const out = transformer.transform(validSchema);
 
@@ -78,7 +81,7 @@ test('Test simple echo function', async () => {
             fieldName
         }
     }`,
-    {}
+    {},
   );
   logDebug(JSON.stringify(response, null, 4));
   expect(response.data.echo.arguments.msg).toEqual('Hello');
@@ -97,7 +100,7 @@ test('Test simple duplicate function', async () => {
             fieldName
         }
     }`,
-    {}
+    {},
   );
   logDebug(JSON.stringify(response, null, 4));
   expect(response.data.duplicate.arguments.msg).toEqual('Hello');
@@ -110,7 +113,7 @@ test('Test pipeline of @function(s)', async () => {
     `query {
         pipeline(msg: "IGNORED")
     }`,
-    {}
+    {},
   );
   logDebug(JSON.stringify(response, null, 4));
   expect(response.data.pipeline).toEqual('Hello, world!');
@@ -127,7 +130,7 @@ test('Test pipelineReverse of @function(s)', async () => {
             fieldName
         }
     }`,
-    {}
+    {},
   );
   logDebug(JSON.stringify(response, null, 4));
   expect(response.data.pipelineReverse.arguments.msg).toEqual('Hello');

diff --git a/packages/amplify-util-mock/src/__e2e__/key-transformer.e2e.test.ts b/packages/amplify-util-mock/src/__e2e__/key-transformer.e2e.test.ts
@@ -2,7 +2,7 @@ import { deploy, launchDDBLocal, logDebug, terminateDDB } from './utils/index';
 
 import { DynamoDBModelTransformer } from 'graphql-dynamodb-transformer';
 import { GraphQLClient } from './utils/graphql-client';
-import { GraphQLTransform } from 'graphql-transformer-core';
+import { FeatureFlagProvider, GraphQLTransform } from 'graphql-transformer-core';
 import { KeyTransformer } from 'graphql-key-transformer';
 
 jest.setTimeout(2000000);
@@ -62,6 +62,9 @@ beforeAll(async () => {
     `;
   const transformer = new GraphQLTransform({
     transformers: [new DynamoDBModelTransformer(), new KeyTransformer()],
+    featureFlags: {
+      getBoolean: name => (name === 'improvePluralization' ? true : false),
+    } as FeatureFlagProvider,
   });
   const out = transformer.transform(validSchema);
   let ddbClient;

diff --git a/packages/amplify-util-mock/src/__e2e__/key-with-auth.e2e.test.ts b/packages/amplify-util-mock/src/__e2e__/key-with-auth.e2e.test.ts
@@ -1,7 +1,7 @@
 import { ModelAuthTransformer } from 'graphql-auth-transformer';
 import { DynamoDBModelTransformer } from 'graphql-dynamodb-transformer';
 import { KeyTransformer } from 'graphql-key-transformer';
-import { GraphQLTransform } from 'graphql-transformer-core';
+import { FeatureFlagProvider, GraphQLTransform } from 'graphql-transformer-core';
 import { signUpAddToGroupAndGetJwtToken } from './utils/cognito-utils';
 import { GraphQLClient } from './utils/graphql-client';
 import { deploy, launchDDBLocal, logDebug, terminateDDB } from './utils/index';
@@ -67,6 +67,9 @@ beforeAll(async () => {
         },
       }),
     ],
+    featureFlags: {
+      getBoolean: name => (name === 'improvePluralization' ? true : false),
+    } as FeatureFlagProvider,
   });
 
   try {