Feature Flag for Nested Mutations: CLI changes

[severussundar]

Why make this change?

• Closes Add support for enabling nested mutation from CLI #1950
  • Introduces a feature flag in the config for nested mutation operations.
  • Feature Flag format:

     "runtime":{
      ...
       "graphql": {
           ...
           "nested-mutations": {
               "create": {
                     "enabled": true/false
                }
           }
       } 
     }

• CLI Option: --graphql.nested-create.enabled. This option can be used along with init command to enable/disable nested insert operation.
• By default, the nested mutation operations will be disabled.
• Nested Mutation operations are applicable only for MsSQL database type. So, when the option --graphql.nested-create.enabled is used along with other database types, it is not honored and nested mutation operations will be disabled. Nested Mutation section will not be written to the config file. In addition, a warning will be logged to let users know that the option is inapplicable.

What is this change?

• dab.draft.schema.json - The schema file is updated to contain details about the new fields
• InitOptions - A new option --graphql.nested-create.enabled is introduced for the init command.
• NestedCreateOptionsConverter - Custom converter to read & write the options for nested insert operation from/to the config file respectively.
• NestedMutationOptionsConverter - Custom converter to read & write the options for nested mutation operations from/to the config file respectively.
• GraphQLRuntimeOptionsConverterFactory - Updates the logic for reading and writing the graphQL runtime section of the config file. Incorporates logic for reading and writing the nested mutation operation options.
• dab-config.*.json/Multidab-config.*.json - All the reference config files are updated to include the new Nested Mutation options

How was this tested?

• Integration Tests
• Unit Tests
• Manual Tests

Sample Commands

• Nested Create Operations are enabled:
  dab init --database-type mssql --connection-string connString --graphql.nested-create.enabled true
  

• Nested Create Operations are disabled:
  dab init --database-type mssql --connection-string connString --graphql.nested-create.enabled false
  

• When --graphql.nested-create.graphql option is not used in the init command:
  dab init --database-type mssql --connection-string connString
  

• When --graphql.nested-create.graphql option is used with a database type other than MsSQL:
  

[severussundar]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 6 pipeline(s).

[abhishekkumams]

/azp run

[Aniruddh25]

Need to fix a typo, LGTM otherwise.

[Aniruddh25]

Seems like this open issue in the graphql spec: graphql/graphql-spec#252 contradicts with what we are calling as nested mutations. I think we should rename the feature to avoid confusion in its usage to something like multiple-mutations + multiple-create, since our feature specifically means performing multiple mutations on related entities in a serial manner.

Nested-mutations as per the open issue in the community refers to having a mutation operation under another query/mutation node - which is not what we plan to do here.

Thanks to @michaelstaib for bringing this up.

[michaelstaib]

@severussundar what you are doing is correct and spec compliant. It looks very similar to what is referred to as batch mutation where the input represents not a single mutation but potentially multiple.

mutation {
  updateCart(input: { productToAdd: [  ...], productsToRemove: [  ...] }) {   ...}
}

Nested Mutations in the GraphQL world would be something aking to:

mutation {
   product { create(input .... }
}

[seantleonard]

Some questions about conditions and valid config representations of nested mutations section. Should be good to go after addressing.

[severussundar]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).

[severussundar]

Rename of the CLI options, JSON fields etc. (replacing nested mutations/nested create with a different name)
will be taken up in a follow-up PR. Created this issue for tracking the same.

Comments addressed

[Aniruddh25]

LGTM! Thanks for your patience in the review.

[seantleonard]

Lgtm! thanks for addressing the various iterations of feedback.