Return generic error messages in production mode

[severussundar]

Why make this change?

• Closes Genericize error messages between bad procedure and table/view requests #671
  • Consider a GET request such as : api/Book/id/one.
    The parameter type for id should be an int. In such a case, the error message returned is the following
    "Parameter \"one\" cannot be resolved as column \"id\" with type \"Int32\".",
    While this error message is helpful, it reveals more information than necessary. For example, it can be deduced from the error message that the database object backing the entity Book is a table and the system type for the column id is Int32
  • To not reveal additional information, a generic error message: Invalid value provided for field: id will be returned when running in Production mode. When running in Development mode, the detailed error message will be returned.
  • When parameters/arguements are provided with incorrect type values in the graphQL requests, a generic error message : The specified argument value does not match the argument type is returned irrespective of the host mode being Development or Production.

What is this change?

• A new method IsDevelopmentMode() is introduced in the ISqlMetadataProvider interface and implementations for this method is provided by the implementing classes.
• Exceptions are constructed with different error messages for Production and Development host modes.
• Tests are added only for SQL database types as the error messages for REST requests reveal additional information about the entities. GraphQL requests return a generic error when running in both Development and Production mode. So, no tests are added for Cosmos.

Additional Refactoring Changes

• A common method GetParamAsSystemType is introduced which casts the parameter values for tables, views and stored-procedures to the respective column/parameter system types. Separate methods for such casting for tables, views and stored-procedures is refactored to a single common method.

How was this tested?

• Integration Tests
• Manually

Sample requests

Error Message when running in Development mode:

Error Message when running in Production mode:

[severussundar]

                // This case should not arise. We have issue for this to handle nullable type columns. Issue #146.

Just curious, was this issue resolved now? If yes, does this need to be modified in any way - doesnt have to be part of this PR - but wondering if we need to fix this.

---

Refers to: src/Service/Resolvers/Sql Query Structures/SqlQueryStructure.cs:520 in 4f947e5. [](commit_id = 4f947e5, deletion_comment = False)

---

This was resolved by PR #324. I'll pick up the refactoring changes to remove code paths that don't get executed in a follow-up PR. I've created this issue to track

[ayush3797]

Leaving few comments to address, LGTM otherwise.

[Aniruddh25]

                message: $"{columnName} is not a valid column of {DatabaseObject.Name}",

Why are we using the same message here irrespective development mode?

---

Refers to: src/Service/Resolvers/Sql Query Structures/BaseSqlQueryStructure.cs:126 in 4f947e5. [](commit_id = 4f947e5, deletion_comment = False)

[Aniruddh25]

LGTM. Left few nits. Thanks for refactoring!

[severussundar]

                message: $"{columnName} is not a valid column of {DatabaseObject.Name}",

Why are we using the same message here irrespective development mode?

Refers to: src/Service/Resolvers/Sql Query Structures/BaseSqlQueryStructure.cs:126 in 4f947e5. [](commit_id = 4f947e5, deletion_comment = False)

In BaseSqlQueryStructure.GetColumnSystemType(), that code block never gets executed.

REST Requests:

If an invalid column name is used in the requests, it gets caught in RequestValidator.ValidateRequestContext() for REST requests. The execution does not reach this point. Both in development and production modes, the following error message is returned.

Request: https://localhost:5001/api/Book/id/1?$select=id,hello

Error Message: Invalid field to be returned requested: hello

GraphQL requests:

Incase of graphQL requests, hotchocolate catches this and returns the following error message when running in both development and production modes.
Error message: The field `hello` does not exist on the type `book`

---

The code flow in BaseSqlQueryStructure.GetColumnSystemType() where the exception is thrown can be removed which I'll take up in issue #1387