fix(graphql-transformer-common): improve generated graphql pluralizat…

…ion (aws-amplify#7258)

This commit adds the `pluralize` npm library instead of blindly appending an "s" to acheive
pluralization. For example, a model named "Match" should pluralize to "Matches", but before this
commit Amplify would pluralize it to "Matchs"

fix aws-amplify#4224

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);
 
         /**

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',
@@ -619,7 +625,7 @@ export class FeatureFlags {
         type: 'boolean',
         defaultValueForExistingProjects: false,
         defaultValueForNewProjects: true,
-      }
+      },
     ]);
 
     this.registerFlag('appSync', [

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',

packages/amplify-graphql-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();

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,

packages/amplify-graphql-transformer-core/src/transformation/transform.ts

@@ -61,7 +61,7 @@ export interface GraphQLTransformOptions {
   readonly authConfig?: AppSyncAuthConfiguration;
   readonly buildParameters?: Record<string, any>;
   readonly stacks?: Record<string, Template>;
-  readonly featuerFlags?: FeatureFlagProvider;
+  readonly featureFlags?: FeatureFlagProvider;
 }
 export type StackMapping = { [resourceId: string]: string };
 export class GraphQLTransform {
@@ -110,7 +110,7 @@ export class GraphQLTransform {
     this.seenTransformations = {};
     const parsedDocument = parse(schema);
     this.app = new App();
-    const context = new TransformerContext(this.app, parsedDocument, this.stackMappingOverrides, this.options.featuerFlags);
+    const context = new TransformerContext(this.app, parsedDocument, this.stackMappingOverrides, this.options.featureFlags);
     const validDirectiveNameMap = this.transformers.reduce(
       (acc: any, t: TransformerPluginProvider) => ({ ...acc, [t.directive.name.value]: true }),
       {

packages/amplify-graphql-transformer-core/src/transformer-context/index.ts

@@ -26,15 +26,20 @@ export class TransformerContext implements TransformerContextProvider {
   public readonly resourceHelper: TransformerResourceHelper;
   public readonly featureFlags: FeatureFlagProvider;
   public _api?: GraphQLAPIProvider;
-  constructor(app: App, public readonly inputDocument: DocumentNode, stackMapping: Record<string, string>, featuerFlags?: FeatureFlagProvider) {
+  constructor(
+    app: App,
+    public readonly inputDocument: DocumentNode,
+    stackMapping: Record<string, string>,
+    featureFlags?: FeatureFlagProvider,
+  ) {
     this.output = new TransformerOutput(inputDocument);
     this.resolvers = new ResolverManager();
     this.dataSources = new TransformerDataSourceManager();
     this.providerRegistry = new TransformerContextProviderRegistry();
-    const stackManager = new  StackManager(app, stackMapping);
-    this.stackManager = stackManager
+    const stackManager = new StackManager(app, stackMapping);
+    this.stackManager = stackManager;
     this.resourceHelper = new TransformerResourceHelper(stackManager);
-    this.featureFlags = featuerFlags ?? new NoopFeatureFlagProvider();
+    this.featureFlags = featureFlags ?? new NoopFeatureFlagProvider();
   }
 
   /**

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

@@ -414,7 +414,7 @@ async function _buildProject(opts: ProjectOptions<TransformerFactoryArgs>) {
     authConfig: opts.authConfig,
     buildParameters: opts.buildParameters,
     stacks: opts.projectConfig.stacks || {},
-    featuerFlags: new AmplifyCLIFeatureFlagAdapter(),
+    featureFlags: new AmplifyCLIFeatureFlagAdapter(),
   });
   return transform.transform(userProjectConfig.schema.toString());
 }

packages/amplify-util-mock/src/__e2e__/model-auth-transformer.e2e.test.ts

@@ -792,7 +792,7 @@ test(`Test getSalary w/ Admin group protection not authorized`, async () => {
   expect((req2.errors[0] as any).errorType).toEqual('Unauthorized');
 });
 
-test(`Test listSalarys w/ Admin group protection authorized`, async () => {
+test(`Test listSalaries w/ Admin group protection authorized`, async () => {
   const req = await GRAPHQL_CLIENT_1.query(`
     mutation {
         createSalary(input: { wage: 101 }) {
@@ -806,20 +806,20 @@ test(`Test listSalarys w/ Admin group protection authorized`, async () => {
   expect(req.data.createSalary.wage).toEqual(101);
   const req2 = await GRAPHQL_CLIENT_1.query(`
     query {
-        listSalarys(filter: { wage: { eq: 101 }}) {
+        listSalaries(filter: { wage: { eq: 101 }}) {
             items {
                 id
                 wage
             }
         }
     }
     `);
-  expect(req2.data.listSalarys.items.length).toEqual(1);
-  expect(req2.data.listSalarys.items[0].id).toEqual(req.data.createSalary.id);
-  expect(req2.data.listSalarys.items[0].wage).toEqual(101);
+  expect(req2.data.listSalaries.items.length).toEqual(1);
+  expect(req2.data.listSalaries.items[0].id).toEqual(req.data.createSalary.id);
+  expect(req2.data.listSalaries.items[0].wage).toEqual(101);
 });
 
-test(`Test listSalarys w/ Admin group protection not authorized`, async () => {
+test(`Test listSalaries w/ Admin group protection not authorized`, async () => {
   const req = await GRAPHQL_CLIENT_1.query(`
     mutation {
         createSalary(input: { wage: 102 }) {
@@ -833,15 +833,15 @@ test(`Test listSalarys w/ Admin group protection not authorized`, async () => {
   expect(req.data.createSalary.wage).toEqual(102);
   const req2 = await GRAPHQL_CLIENT_2.query(`
     query {
-        listSalarys(filter: { wage: { eq: 102 }}) {
+        listSalaries(filter: { wage: { eq: 102 }}) {
             items {
                 id
                 wage
             }
         }
     }
     `);
-  expect(req2.data.listSalarys.items).toEqual([]);
+  expect(req2.data.listSalaries.items).toEqual([]);
 });
 
 /**
@@ -2374,7 +2374,7 @@ test(`Test createTestIdentity as admin.`, async () => {
 
   const listResponse = await GRAPHQL_CLIENT_3.query(
     `query {
-        listTestIdentitys(filter: { title: { eq: "Test title update" } }, limit: 100) {
+        listTestIdentities(filter: { title: { eq: "Test title update" } }, limit: 100) {
             items {
                 id
                 title
@@ -2384,7 +2384,7 @@ test(`Test createTestIdentity as admin.`, async () => {
     }`,
     {},
   );
-  const relevantPost = listResponse.data.listTestIdentitys.items.find(p => p.id === getReq.data.getTestIdentity.id);
+  const relevantPost = listResponse.data.listTestIdentities.items.find(p => p.id === getReq.data.getTestIdentity.id);
   logDebug(JSON.stringify(listResponse, null, 4));
   expect(relevantPost).toBeTruthy();
   expect(relevantPost.title).toEqual('Test title update');

packages/graphql-auth-transformer/src/ModelAuthTransformer.ts

@@ -368,7 +368,7 @@ export class ModelAuthTransformer extends Transformer {
     this.propagateAuthDirectivesToNestedTypes(def, rules, ctx);
 
     // Retrieve the configuration options for the related @model directive
-    const modelConfiguration = new ModelDirectiveConfiguration(modelDirective, def);
+    const modelConfiguration = new ModelDirectiveConfiguration(modelDirective, def, ctx.featureFlags.getBoolean('improvePluralization'));
 
     // Get the directives we need to add to the GraphQL nodes
     const directives = this.getDirectivesForRules(rules, rules.length === 0 ? this.shouldAddDefaultAuthDirective() : false);
@@ -516,7 +516,11 @@ Static group authorization should perform as expected.`,
       const isDeleteRule = isOpRule('delete');
 
       // Retrieve the configuration options for the related @model directive
-      const modelConfiguration = new ModelDirectiveConfiguration(modelDirective, parent);
+      const modelConfiguration = new ModelDirectiveConfiguration(
+        modelDirective,
+        parent,
+        ctx.featureFlags.getBoolean('improvePluralization'),
+      );
       // The field handler adds the read rule on the object
       const readRules = rules.filter((rule: AuthRule) => isReadRule(rule));
       this.protectReadForField(ctx, parent, definition, readRules, modelConfiguration);

packages/graphql-auth-transformer/src/ModelDirectiveConfiguration.ts

@@ -41,12 +41,14 @@ type ModelDirectiveOperation = {
 export class ModelDirectiveConfiguration {
   map: Map<ModelDirectiveOperationType, ModelDirectiveOperation> = new Map();
 
-  constructor(directive: DirectiveNode, def: ObjectTypeDefinitionNode) {
+  constructor(directive: DirectiveNode, def: ObjectTypeDefinitionNode, improvePluralization: boolean) {
     const typeName = def.name.value;
     const directiveArguments: ModelDirectiveArgs = getDirectiveArguments(directive);
 
     const makeName = (operation: ModelDirectiveOperationType, nameOverride?: string, isList: boolean = false) =>
-      nameOverride ? nameOverride : graphqlName(operation + (isList ? plurality(toUpper(typeName)) : toUpper(typeName)));
+      nameOverride
+        ? nameOverride
+        : graphqlName(operation + (isList ? plurality(toUpper(typeName), improvePluralization) : toUpper(typeName)));
 
     let shouldHaveCreate = true;
     let shouldHaveUpdate = true;