Refactor where @ is added to paramName (#1212)

ayush3797 · web-flow · commit 06d21b76e472 · 2023-02-15T12:58:56.000-08:00
## Why make this change?
We were prefixing params with an '@' at lot of places scattered throughout the code. This change centralizes this prefixing to one method `BaseQueryStructure.MakeParamWithValue` method.

## How was this tested?
No need to write additional tests. Just a refactor. Existing unit/integration tests are passing.
diff --git a/src/Service/Models/GraphQLFilterParsers.cs b/src/Service/Models/GraphQLFilterParsers.cs
@@ -460,7 +460,7 @@ public static Predicate Parse(
                 predicates.Push(new PredicateOperand(new Predicate(
                     new PredicateOperand(column),
                     op,
-                    new PredicateOperand(processLiteral ? $"@{processLiterals(value)}" : value.ToString()))
+                    new PredicateOperand(processLiteral ? $"{processLiterals(value)}" : value.ToString()))
                 ));
             }
 
diff --git a/src/Service/Parsers/ODataASTVisitor.cs b/src/Service/Parsers/ODataASTVisitor.cs
@@ -78,7 +78,7 @@ public override string Visit(ConstantNode nodeIn)
                 return "NULL";
             }
 
-            return $"@{_struct.MakeParamWithValue(GetParamWithSystemType(nodeIn.Value.ToString()!, nodeIn.TypeReference))}";
+            return $"{_struct.MakeParamWithValue(GetParamWithSystemType(nodeIn.Value.ToString()!, nodeIn.TypeReference))}";
         }
 
         /// <summary>
diff --git a/src/Service/Resolvers/BaseQueryStructure.cs b/src/Service/Resolvers/BaseQueryStructure.cs
@@ -69,6 +69,8 @@ public class BaseQueryStructure
         /// </summary>
         public IAuthorizationResolver AuthorizationResolver { get; }
 
+        public const string PARAM_NAME_PREFIX = "@";
+
         public BaseQueryStructure(
             ISqlMetadataProvider metadataProvider,
             IAuthorizationResolver authorizationResolver,
@@ -109,7 +111,7 @@ public BaseQueryStructure(
         /// <param name="value">Value to be assigned to parameter, which can be null for nullable columns.</param>
         public string MakeParamWithValue(object? value)
         {
-            string paramName = $"param{Counter.Next()}";
+            string paramName = $"{PARAM_NAME_PREFIX}param{Counter.Next()}";
             Parameters.Add(paramName, value);
             return paramName;
         }
diff --git a/src/Service/Resolvers/CosmosQueryEngine.cs b/src/Service/Resolvers/CosmosQueryEngine.cs
@@ -73,7 +73,7 @@ public async Task<Tuple<JsonDocument, IMetadata>> ExecuteAsync(
 
             foreach (KeyValuePair<string, object> parameterEntry in structure.Parameters)
             {
-                querySpec = querySpec.WithParameter("@" + parameterEntry.Key, parameterEntry.Value);
+                querySpec = querySpec.WithParameter(parameterEntry.Key, parameterEntry.Value);
             }
 
             if (!string.IsNullOrEmpty(partitionKeyValue))
@@ -156,7 +156,7 @@ public async Task<Tuple<IEnumerable<JsonDocument>, IMetadata>> ExecuteListAsync(
 
             foreach (KeyValuePair<string, object> parameterEntry in structure.Parameters)
             {
-                querySpec = querySpec.WithParameter("@" + parameterEntry.Key, parameterEntry.Value);
+                querySpec = querySpec.WithParameter(parameterEntry.Key, parameterEntry.Value);
             }
 
             FeedIterator<JObject> resultSetIterator = container.GetItemQueryIterator<JObject>(querySpec);
diff --git a/src/Service/Resolvers/CosmosQueryStructure.cs b/src/Service/Resolvers/CosmosQueryStructure.cs
@@ -148,7 +148,7 @@ private void Init(IDictionary<string, object?> queryParams)
                     Predicates.Add(new Predicate(
                         new PredicateOperand(new Column(tableSchema: string.Empty, _containerAlias, parameter.Key)),
                         PredicateOperation.Equal,
-                        new PredicateOperand($"@{MakeParamWithValue(parameter.Value)}")
+                        new PredicateOperand($"{MakeParamWithValue(parameter.Value)}")
                     ));
                 }
             }
diff --git a/src/Service/Resolvers/MsSqlQueryExecutor.cs b/src/Service/Resolvers/MsSqlQueryExecutor.cs
@@ -177,15 +177,15 @@ public override string GetSessionParamsQuery(HttpContext? httpContext, IDictiona
 
             // Counter to generate different param name for each of the sessionParam.
             IncrementingInteger counter = new();
-            const string paramNamePrefix = "session_param";
+            const string SESSION_PARAM_NAME = $"{BaseQueryStructure.PARAM_NAME_PREFIX}session_param";
             StringBuilder sessionMapQuery = new();
 
             foreach ((string claimType, Claim claim) in sessionParams)
             {
-                string paramName = $"{paramNamePrefix}{counter.Next()}";
+                string paramName = $"{SESSION_PARAM_NAME}{counter.Next()}";
                 parameters.Add(paramName, claim.Value);
                 // Append statement to set read only param value - can be set only once for a connection.
-                string statementToSetReadOnlyParam = "EXEC sp_set_session_context " + $"'{claimType}', @" + paramName + ", @read_only = 1;";
+                string statementToSetReadOnlyParam = "EXEC sp_set_session_context " + $"'{claimType}', " + paramName + ", @read_only = 1;";
                 sessionMapQuery = sessionMapQuery.Append(statementToSetReadOnlyParam);
             }
 
diff --git a/src/Service/Resolvers/QueryExecutor.cs b/src/Service/Resolvers/QueryExecutor.cs
@@ -153,7 +153,7 @@ await ExecuteQueryAgainstDbAsync(conn,
                 foreach (KeyValuePair<string, object?> parameterEntry in parameters)
                 {
                     DbParameter parameter = cmd.CreateParameter();
-                    parameter.ParameterName = "@" + parameterEntry.Key;
+                    parameter.ParameterName = parameterEntry.Key;
                     parameter.Value = parameterEntry.Value ?? DBNull.Value;
                     cmd.Parameters.Add(parameter);
                 }
diff --git a/src/Service/Resolvers/Sql Query Structures/BaseSqlQueryStructure.cs b/src/Service/Resolvers/Sql Query Structures/BaseSqlQueryStructure.cs
@@ -85,7 +85,7 @@ public void AddNullifiedUnspecifiedFields(
                     Predicate predicate = new(
                         new PredicateOperand(new Column(tableSchema: DatabaseObject.SchemaName, tableName: DatabaseObject.Name, leftoverColumn)),
                         PredicateOperation.Equal,
-                        new PredicateOperand($"@{MakeParamWithValue(value: null)}")
+                        new PredicateOperand($"{MakeParamWithValue(value: null)}")
                     );
 
                     updateOperations.Add(predicate);
diff --git a/src/Service/Resolvers/Sql Query Structures/SqlDeleteQueryStructure.cs b/src/Service/Resolvers/Sql Query Structures/SqlDeleteQueryStructure.cs
@@ -45,7 +45,7 @@ public SqlDeleteStructure(
                     Predicates.Add(new Predicate(
                         new PredicateOperand(new Column(DatabaseObject.SchemaName, DatabaseObject.Name, backingColumn!)),
                         PredicateOperation.Equal,
-                        new PredicateOperand($"@{MakeParamWithValue(GetParamAsColumnSystemType(param.Value.ToString()!, backingColumn!))}")
+                        new PredicateOperand($"{MakeParamWithValue(GetParamAsColumnSystemType(param.Value.ToString()!, backingColumn!))}")
                     ));
                 }
             }
diff --git a/src/Service/Resolvers/Sql Query Structures/SqlExecuteQueryStructure.cs b/src/Service/Resolvers/Sql Query Structures/SqlExecuteQueryStructure.cs
@@ -48,7 +48,7 @@ public SqlExecuteStructure(
                     {
                         string parameterizedName = MakeParamWithValue(requestParamValue is null ? null :
                             GetParamAsProcedureParameterType(requestParamValue.ToString()!, paramKey));
-                        ProcedureParameters.Add(paramKey, $"@{parameterizedName}");
+                        ProcedureParameters.Add(paramKey, $"{parameterizedName}");
                     }
                     catch (ArgumentException ex)
                     {
@@ -67,7 +67,7 @@ public SqlExecuteStructure(
                     if (paramDefinition.HasConfigDefault)
                     {
                         string parameterizedName = MakeParamWithValue(paramDefinition.ConfigDefaultValue);
-                        ProcedureParameters.Add(paramKey, $"@{parameterizedName}");
+                        ProcedureParameters.Add(paramKey, $"{parameterizedName}");
                     }
                     else
                     {
diff --git a/src/Service/Resolvers/Sql Query Structures/SqlInsertQueryStructure.cs b/src/Service/Resolvers/Sql Query Structures/SqlInsertQueryStructure.cs
@@ -91,7 +91,7 @@ private void PopulateColumnsAndParams(string columnName, object? value)
                     paramName = MakeParamWithValue(null);
                 }
 
-                Values.Add($"@{paramName}");
+                Values.Add($"{paramName}");
             }
             catch (ArgumentException ex)
             {
diff --git a/src/Service/Resolvers/Sql Query Structures/SqlQueryStructure.cs b/src/Service/Resolvers/Sql Query Structures/SqlQueryStructure.cs
@@ -484,7 +484,7 @@ private void AddPrimaryKeyPredicates(IDictionary<string, object?> queryParams)
                                                     columnName: columnName,
                                                     tableAlias: SourceAlias)),
                     PredicateOperation.Equal,
-                    new PredicateOperand($"@{MakeParamWithValue(parameter.Value)}")
+                    new PredicateOperand($"{MakeParamWithValue(parameter.Value)}")
                 ));
             }
         }
@@ -506,8 +506,8 @@ public void AddPaginationPredicate(IEnumerable<PaginationColumn> afterJsonValues
                 {
                     column.TableAlias = SourceAlias;
                     column.ParamName = column.Value is not null ?
-                        "@" + MakeParamWithValue(GetParamAsColumnSystemType(column.Value!.ToString()!, column.ColumnName)) :
-                        "@" + MakeParamWithValue(null);
+                        MakeParamWithValue(GetParamAsColumnSystemType(column.Value!.ToString()!, column.ColumnName)) :
+                        MakeParamWithValue(null);
                 }
             }
             catch (ArgumentException ex)
@@ -542,7 +542,7 @@ private void PopulateParamsAndPredicates(string field, string backingColumn, obj
                     Predicates.Add(new Predicate(
                         new PredicateOperand(new Column(DatabaseObject.SchemaName, DatabaseObject.Name, backingColumn, SourceAlias)),
                         op,
-                        new PredicateOperand($"@{parameterName}")));
+                        new PredicateOperand($"{parameterName}")));
                 }
                 else
                 {
@@ -842,7 +842,7 @@ private void ParametrizeColumns()
         {
             foreach (LabelledColumn column in Columns)
             {
-                ColumnLabelToParam.Add(column.Label, $"@{MakeParamWithValue(column.Label)}");
+                ColumnLabelToParam.Add(column.Label, $"{MakeParamWithValue(column.Label)}");
             }
         }
     }
diff --git a/src/Service/Resolvers/Sql Query Structures/SqlUpdateQueryStructure.cs b/src/Service/Resolvers/Sql Query Structures/SqlUpdateQueryStructure.cs
@@ -158,7 +158,7 @@ private Predicate CreatePredicateForParam(KeyValuePair<string, object?> param)
                     new PredicateOperand(
                         new Column(tableSchema: DatabaseObject.SchemaName, tableName: DatabaseObject.Name, backingColumn!)),
                     PredicateOperation.Equal,
-                    new PredicateOperand($"@{MakeParamWithValue(null)}")
+                    new PredicateOperand($"{MakeParamWithValue(null)}")
                 );
             }
             else
@@ -167,7 +167,7 @@ private Predicate CreatePredicateForParam(KeyValuePair<string, object?> param)
                     new PredicateOperand(
                         new Column(tableSchema: DatabaseObject.SchemaName, tableName: DatabaseObject.Name, param.Key)),
                     PredicateOperation.Equal,
-                    new PredicateOperand($"@{MakeParamWithValue(GetParamAsColumnSystemType(param.Value.ToString()!, param.Key))}"));
+                    new PredicateOperand($"{MakeParamWithValue(GetParamAsColumnSystemType(param.Value.ToString()!, param.Key))}"));
             }
 
             return predicate;
diff --git a/src/Service/Resolvers/Sql Query Structures/SqlUpsertQueryStructure.cs b/src/Service/Resolvers/Sql Query Structures/SqlUpsertQueryStructure.cs
@@ -128,7 +128,7 @@ private void PopulateColumns(
                     Predicate predicate = new(
                         new PredicateOperand(new Column(tableSchema: DatabaseObject.SchemaName, tableName: DatabaseObject.Name, columnName: backingColumn!)),
                         PredicateOperation.Equal,
-                        new PredicateOperand($"@{paramIdentifier}")
+                        new PredicateOperand($"{paramIdentifier}")
                     );
 
                     // We are guaranteed by the RequestValidator, that a primary key column is in the URL, not body.
@@ -189,7 +189,7 @@ private void PopulateColumnsAndParams(string columnName)
             InsertColumns.Add(columnName);
             string paramName;
             paramName = ColumnToParam[columnName];
-            Values.Add($"@{paramName}");
+            Values.Add($"{paramName}");
         }
 
         /// <summary>

Original file line number	Diff line number	Diff line change
`@@ -460,7 +460,7 @@ public static Predicate Parse(`
`460`	`460`	`predicates.Push(new PredicateOperand(new Predicate(`
`461`	`461`	`new PredicateOperand(column),`
`462`	`462`	`op,`
`463`		`- new PredicateOperand(processLiteral ? $"@{processLiterals(value)}" : value.ToString()))`
	`463`	`+ new PredicateOperand(processLiteral ? $"{processLiterals(value)}" : value.ToString()))`
`464`	`464`	`));`
`465`	`465`	`}`
`466`	`466`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ public override string Visit(ConstantNode nodeIn)`
`78`	`78`	`return "NULL";`
`79`	`79`	`}`
`80`	`80`
`81`		`- return $"@{_struct.MakeParamWithValue(GetParamWithSystemType(nodeIn.Value.ToString()!, nodeIn.TypeReference))}";`
	`81`	`+ return $"{_struct.MakeParamWithValue(GetParamWithSystemType(nodeIn.Value.ToString()!, nodeIn.TypeReference))}";`
`82`	`82`	`}`
`83`	`83`
`84`	`84`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ public async Task<Tuple<JsonDocument, IMetadata>> ExecuteAsync(`
`73`	`73`
`74`	`74`	`foreach (KeyValuePair<string, object> parameterEntry in structure.Parameters)`
`75`	`75`	`{`
`76`		`- querySpec = querySpec.WithParameter("@" + parameterEntry.Key, parameterEntry.Value);`
	`76`	`+ querySpec = querySpec.WithParameter(parameterEntry.Key, parameterEntry.Value);`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`if (!string.IsNullOrEmpty(partitionKeyValue))`
`@@ -156,7 +156,7 @@ public async Task<Tuple<IEnumerable<JsonDocument>, IMetadata>> ExecuteListAsync(`
`156`	`156`
`157`	`157`	`foreach (KeyValuePair<string, object> parameterEntry in structure.Parameters)`
`158`	`158`	`{`
`159`		`- querySpec = querySpec.WithParameter("@" + parameterEntry.Key, parameterEntry.Value);`
	`159`	`+ querySpec = querySpec.WithParameter(parameterEntry.Key, parameterEntry.Value);`
`160`	`160`	`}`
`161`	`161`
`162`	`162`	`FeedIterator<JObject> resultSetIterator = container.GetItemQueryIterator<JObject>(querySpec);`
Original file line number	Diff line number	Diff line change
`@@ -148,7 +148,7 @@ private void Init(IDictionary<string, object?> queryParams)`
`148`	`148`	`Predicates.Add(new Predicate(`
`149`	`149`	`new PredicateOperand(new Column(tableSchema: string.Empty, _containerAlias, parameter.Key)),`
`150`	`150`	`PredicateOperation.Equal,`
`151`		`- new PredicateOperand($"@{MakeParamWithValue(parameter.Value)}")`
	`151`	`+ new PredicateOperand($"{MakeParamWithValue(parameter.Value)}")`
`152`	`152`	`));`
`153`	`153`	`}`
`154`	`154`	`}`
Original file line number	Diff line number	Diff line change
`@@ -153,7 +153,7 @@ await ExecuteQueryAgainstDbAsync(conn,`
`153`	`153`	`foreach (KeyValuePair<string, object?> parameterEntry in parameters)`
`154`	`154`	`{`
`155`	`155`	`DbParameter parameter = cmd.CreateParameter();`
`156`		`- parameter.ParameterName = "@" + parameterEntry.Key;`
	`156`	`+ parameter.ParameterName = parameterEntry.Key;`
`157`	`157`	`parameter.Value = parameterEntry.Value ?? DBNull.Value;`
`158`	`158`	`cmd.Parameters.Add(parameter);`
`159`	`159`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public SqlDeleteStructure(`
`45`	`45`	`Predicates.Add(new Predicate(`
`46`	`46`	`new PredicateOperand(new Column(DatabaseObject.SchemaName, DatabaseObject.Name, backingColumn!)),`
`47`	`47`	`PredicateOperation.Equal,`
`48`		`- new PredicateOperand($"@{MakeParamWithValue(GetParamAsColumnSystemType(param.Value.ToString()!, backingColumn!))}")`
	`48`	`+ new PredicateOperand($"{MakeParamWithValue(GetParamAsColumnSystemType(param.Value.ToString()!, backingColumn!))}")`
`49`	`49`	`));`
`50`	`50`	`}`
`51`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public SqlExecuteStructure(`
`48`	`48`	`{`
`49`	`49`	`string parameterizedName = MakeParamWithValue(requestParamValue is null ? null :`
`50`	`50`	`GetParamAsProcedureParameterType(requestParamValue.ToString()!, paramKey));`
`51`		`- ProcedureParameters.Add(paramKey, $"@{parameterizedName}");`
	`51`	`+ ProcedureParameters.Add(paramKey, $"{parameterizedName}");`
`52`	`52`	`}`
`53`	`53`	`catch (ArgumentException ex)`
`54`	`54`	`{`
`@@ -67,7 +67,7 @@ public SqlExecuteStructure(`
`67`	`67`	`if (paramDefinition.HasConfigDefault)`
`68`	`68`	`{`
`69`	`69`	`string parameterizedName = MakeParamWithValue(paramDefinition.ConfigDefaultValue);`
`70`		`- ProcedureParameters.Add(paramKey, $"@{parameterizedName}");`
	`70`	`+ ProcedureParameters.Add(paramKey, $"{parameterizedName}");`
`71`	`71`	`}`
`72`	`72`	`else`
`73`	`73`	`{`