GraphQL Entity Naming Changes

[seantleonard]

Closes #601 - which identifies a bug where configuration defined entity names were not honored verbatim in GraphQL requests.

Note: This complements the work done in #619 to further honor singular/plural defined values for GraphQL entities.

1. The GraphQL schema builder took an entity name from config and sanitized it to follow GraphQL best practices (pascal case/ upper-case first letter).
2. Then, the schema builder used formatted name for the GQL object type definition.
3. Using a sanitized/formatted name value would result in failed lookups within SQLMetadataProvider's EntityToDatabaseObject dictionary, when processing GraphQL requests.

Why this Change?

Our GraphQL Schema generation code takes the entity name present in our runtime config file:

"entities": {
        "todo": {
            "source": "s002.todos",
        }
    }

and formats it to adhere to the GraphQL Specification naming rules.

Names in GraphQL are limited to the Latin ASCII subset of SourceCharacter in order to support interoperation with as many other systems as possible.

and

GraphQL Naming Best Practices

Type names are in pascal case. That means they start with a capital letter. Type names should not contain whitespace dashes or underscores.

Before this change, the entity name todo was formatted to Todo (best practice rule formatting). When the formatted name was used in the SqlMetadataProvider method like: _sqlMetadataProvider.GetDatabaseObjectName("Todo"), the lookup fails due to case-sensitivity (not equal to todo).

Additionally, other schema fields that utilize the Singular/Plural naming like InputTypeFields and Query/Mutation definitions, honor the runtime config settings.

What is this Change?

Removes the name sanitization mechanism from the FormatNameForObject helper method used to convert an entityName in config to a best practice GraphQL name.

This is to adhere to decision made in this comment: #601 (comment)

"Let's generate the entity name using the same casing used in the configuration file"

Bug Fix for Improperly Generated Complex Input Types for Cosmos

A bug was also fixed which improperly created nested input type definitions for Cosmos DB as Cosmos supports nested entity mutations. In the files {Create/Update/Delete}MutationBuilder.cs, the method GetComplexInputType() improperly generated the InputTypeName using the wrong entity object. Because another method parameter, typeName, has the correct value (reference to nested entity), that value is used.
The lines of code that were corrected look like: NameNode inputTypeName = GenerateInputTypeName(typeName);

How was this tested?

• Fix all broken GraphQL tests which had queries/mutations and references to entities with the wrong casing that did not honor the Singular/Plural name or Top-Level entity name defined in the runtime configuration.
• Add validation to startup to ensure developers include valid GraphQL grammar in entity names.

[Aniruddh25]

Need to honor singular plural values from config when generating GraphQL type name for a given entity.

[Aniruddh25]

nit: edit PR description to reflect FormatNameForField is not done either

[Aniruddh25]

Waiting on

1. clarification of model.Name property v/s model.Argument with name argument.
2. space is invalid in names

[Aniruddh25]

LGTM! Thanks for streamlining our GraphQL naming conventions :)

Addressed changes posted, will look into refactoring casting and received later approvals.